X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_html%2Faai_swagger_v11.html;h=e2e7b36bae4498c30ab22c20865ea6936ed08425;hb=a9275b0c30881dac42f364ffca6f0d9cbff1b614;hp=dc95e4bf23ec54c58b0491c31ce5733aeda5ce97;hpb=34f82fce815c23f0ae3df3643ee262af396c236c;p=aai%2Faai-common.git 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 index dc95e4bf..e2e7b36b 100644 --- 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 @@ -1,4 +1,3 @@ - @@ -15,8 +14,11 @@

Active and Available Inventory REST API.

-

Version: v11

-

Copyright © 2017 AT&T Intellectual Property. All rights reserved.
+

Version: v12

+


+[Differences versus the previous schema version](apidocs/aai_swagger_v11.diff)
+
+Copyright © 2017 AT&T Intellectual Property. All rights reserved.

Licensed under the Creative Commons License, Attribution 4.0 Intl. (the "License"); you may not use this documentation except in compliance with the License.

@@ -62,6 +64,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}

create or update an existing cloud-region

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

update an existing cloud-region

@@ -82,6 +89,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/availability-zones/availability-zone/{availability-zone-name}

create or update an existing availability-zone

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

update an existing availability-zone

@@ -112,6 +124,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/dvs-switches/dvs-switch/{switch-name}

create or update an existing dvs-switch

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

update an existing dvs-switch

@@ -142,6 +159,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info

+ + + + PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id} +

update an existing esr-system-info

@@ -172,6 +194,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}

create or update an existing flavor

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

update an existing flavor

@@ -202,6 +229,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}

create or update an existing group-assignment

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

update an existing group-assignment

@@ -232,6 +264,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}

create or update an existing image

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

update an existing image

@@ -252,6 +289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

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

update an existing metadatum

@@ -282,6 +324,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}

create or update an existing oam-network

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

update an existing oam-network

@@ -322,6 +369,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}

create or update an existing snapshot

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

update an existing snapshot

@@ -352,6 +404,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}

create or update an existing tenant

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

update an existing tenant

@@ -382,6 +439,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}

create or update an existing vserver

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

update an existing vserver

@@ -402,6 +464,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

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

update an existing l-interface

@@ -417,6 +484,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

@@ -442,6 +514,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

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

@@ -482,6 +559,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

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

update an existing sriov-vf

@@ -512,6 +594,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

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

update an existing vlan

@@ -527,6 +614,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

@@ -552,6 +644,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

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

@@ -602,6 +699,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}

create or update an existing volume

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

update an existing volume

@@ -617,6 +719,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

delete an existing relationship

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

returns vip-ipv4-address-list

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

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

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

update an existing vip-ipv4-address-list

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

delete an existing vip-ipv4-address-list

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

see node definition for valid relationships

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

delete an existing relationship

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

returns vip-ipv6-address-list

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

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

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

update an existing vip-ipv6-address-list

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

delete an existing vip-ipv6-address-list

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

see node definition for valid relationships

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

delete an existing relationship

@@ -632,6 +794,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}

create or update an existing volume-group

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

update an existing volume-group

@@ -662,6 +829,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/complexes/complex/{physical-location-id}

create or update an existing complex

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

update an existing complex

@@ -682,6 +854,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}

create or update an existing ctag-pool

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

update an existing ctag-pool

@@ -722,6 +899,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}

create or update an existing network-profile

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

update an existing network-profile

@@ -752,6 +934,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}

create or update an existing pserver

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

update an existing pserver

@@ -772,6 +959,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

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

update an existing lag-interface

@@ -792,6 +984,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

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

update an existing l-interface

@@ -807,6 +1004,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

@@ -832,6 +1034,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

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

@@ -872,6 +1079,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

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

update an existing sriov-vf

@@ -902,6 +1114,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

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

update an existing vlan

@@ -917,6 +1134,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

@@ -942,6 +1164,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

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

@@ -992,6 +1219,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

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

update an existing p-interface

@@ -1012,6 +1244,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

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

update an existing l-interface

@@ -1027,6 +1264,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

@@ -1052,6 +1294,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

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

@@ -1092,6 +1339,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

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

update an existing sriov-vf

@@ -1122,6 +1374,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

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

update an existing vlan

@@ -1137,6 +1394,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

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

@@ -1162,6 +1424,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

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

@@ -1212,6 +1479,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

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

update an existing sriov-pf

@@ -1252,6 +1524,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen PUT /cloud-infrastructure/virtual-data-centers/virtual-data-center/{vdc-id}

create or update an existing virtual-data-center

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

update an existing virtual-data-center

@@ -1273,200 +1550,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -

Tag: ExternalSystem

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
OperationDescription
GET /external-system/esr-ems-list

returns esr-ems-list

-
GET /external-system/esr-ems-list/esr-ems/{ems-id}

returns esr-ems

-
PUT /external-system/esr-ems-list/esr-ems/{ems-id}

create or update an existing esr-ems

-
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}

delete an existing esr-ems

-
GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list

returns esr-system-info-list

-
GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info

-
PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info

-
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info

-
PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship

-
PUT /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

delete an existing relationship

-
GET /external-system/esr-thirdparty-sdnc-list

returns esr-thirdparty-sdnc-list

-
GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

returns esr-thirdparty-sdnc

-
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

create or update an existing esr-thirdparty-sdnc

-
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

delete an existing esr-thirdparty-sdnc

-
GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list

returns esr-system-info-list

-
GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info

-
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info

-
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info

-
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship

-
PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

delete an existing relationship

-
GET /external-system/esr-vnfm-list

returns esr-vnfm-list

-
GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

returns esr-vnfm

-
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

create or update an existing esr-vnfm

-
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

delete an existing esr-vnfm

-
GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list

returns esr-system-info-list

-
GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

returns esr-system-info

-
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

create or update an existing esr-system-info

-
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

delete an existing esr-system-info

-
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

delete an existing relationship

-
PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

delete an existing relationship

-
- -

Tag: Business

@@ -1490,6 +1573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1510,6 +1598,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1540,6 +1633,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1570,6 +1668,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1600,6 +1703,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1620,6 +1728,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1650,6 +1763,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1680,6 +1798,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1710,6 +1833,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1740,6 +1868,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1770,6 +1903,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1800,6 +1938,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1844,6 +1987,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1864,6 +2012,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1884,6 +2037,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1904,6 +2062,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1924,6 +2087,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1944,6 +2112,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -1964,6 +2137,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2034,6 +2212,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2054,6 +2237,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2074,6 +2262,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2094,6 +2287,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2144,6 +2342,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2174,6 +2377,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2204,6 +2412,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2235,6 +2448,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2268,6 +2546,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2298,6 +2581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2313,6 +2601,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2338,6 +2631,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2378,6 +2676,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2408,6 +2711,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2423,6 +2731,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2448,6 +2761,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2488,6 +2806,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2508,6 +2831,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2523,6 +2851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2548,6 +2881,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2588,6 +2926,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2618,6 +2961,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2633,6 +2981,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2658,6 +3011,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2708,6 +3066,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2748,6 +3111,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2778,6 +3146,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2808,6 +3181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2838,6 +3216,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2868,6 +3251,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2888,6 +3276,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2928,6 +3321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2958,6 +3356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -2978,6 +3381,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3018,6 +3426,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3048,6 +3461,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3078,6 +3496,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3108,6 +3531,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3138,6 +3566,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3158,6 +3591,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3173,6 +3611,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3198,6 +3641,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3238,6 +3686,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3268,6 +3721,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3283,6 +3741,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3308,6 +3771,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3358,6 +3826,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3388,6 +3861,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3408,6 +3886,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3428,6 +3911,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3443,6 +3931,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3468,6 +3961,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3508,6 +4006,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3538,6 +4041,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3553,6 +4061,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3578,6 +4091,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3628,6 +4146,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3648,6 +4171,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3663,6 +4191,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3688,6 +4221,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3728,6 +4266,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3758,6 +4301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3773,6 +4321,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3798,6 +4351,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3848,6 +4406,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3888,6 +4451,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3918,6 +4486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3948,6 +4521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3978,6 +4556,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -3998,6 +4581,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4038,6 +4626,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4058,6 +4651,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4088,6 +4686,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4118,6 +4721,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4138,6 +4746,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4173,56 +4786,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -4238,6 +4801,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4253,6 +4821,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4278,6 +4851,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4318,6 +4896,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4338,6 +4921,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4358,6 +4946,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4373,6 +4966,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4398,6 +4996,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4438,6 +5041,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4468,6 +5076,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4483,6 +5096,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4508,6 +5126,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4558,6 +5181,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4578,6 +5206,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4593,6 +5226,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4618,6 +5256,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4658,6 +5301,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4688,6 +5336,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4703,6 +5356,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4728,6 +5386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4778,6 +5441,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4818,6 +5486,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4848,6 +5521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4878,6 +5556,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + @@ -4940,7 +5623,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /connectors + /connectors
@@ -5095,7 +5778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /connector + /connector
@@ -5142,7 +5825,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

connector object that needs to be created or updated

+

connector object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)

@@ -5212,6 +5895,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing connector
+

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

+ Tags: + Business +
+
+
+

update an existing connector

+ +
+
+ +

application/json application/xml +

+
+
+

connector object that needs to be created or updated.

+

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

create or update an existing connector

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

update an existing connector
PUT /business/connectors/connector/{resource-instance-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

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

update an existing metadatum
PUT /business/customers/customer/{global-customer-id}

create or update an existing customer

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

update an existing customer
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}

create or update an existing service-subscription

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

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

create or update an existing service-instance

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

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

create or update an existing allotted-resource

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

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

create or update an existing tunnel-xconnect

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

update an existing tunnel-xconnect
PUT /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/metadata/metadatum/{metaname}

create or update an existing metadatum

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

update an existing metadatum
PUT /business/lines-of-business/line-of-business/{line-of-business-name}

create or update an existing line-of-business

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

update an existing line-of-business
PUT /business/owning-entities/owning-entity/{owning-entity-id}

create or update an existing owning-entity

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

update an existing owning-entity
PUT /business/platforms/platform/{platform-name}

create or update an existing platform

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

update an existing platform
PUT /business/projects/project/{project-name}

create or update an existing project

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

update an existing project
PUT /service-design-and-creation/models/model/{model-invariant-id}

create or update an existing model

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

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

create or update an existing model-ver

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

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

create or update an existing metadatum

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

update an existing metadatum
PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

create or update an existing model-element

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

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

create or update an existing model-constraint

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

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

create or update an existing constrained-element-set

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

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

create or update an existing element-choice-set

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

update an existing element-choice-set
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}

create or update an existing named-query

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

update an existing named-query
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

create or update an existing named-query-element

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

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

create or update an existing property-constraint

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

update an existing property-constraint
PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

create or update an existing related-lookup

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

update an existing related-lookup
PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

create or update an existing service-capability

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

update an existing service-capability
PUT /service-design-and-creation/services/service/{service-id}

create or update an existing service

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

update an existing service
PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

create or update an existing vnf-image

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

update an existing vnf-image
GET /network/configurations

returns configurations

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

returns configuration

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

create or update an existing configuration

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

update an existing configuration

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

delete an existing configuration

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

returns metadata

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

returns metadatum

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

create or update an existing metadatum

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

update an existing metadatum

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

delete an existing metadatum

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /network/generic-vnfs

returns generic-vnfs

@@ -2248,6 +2521,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
PUT /network/generic-vnfs/generic-vnf/{vnf-id}

create or update an existing generic-vnf

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

update an existing generic-vnf
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

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

update an existing entitlement
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

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

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

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

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

update an existing l3-interface-ipv4-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

update an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

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

update an existing sriov-vf
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

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

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

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

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

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

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

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

update an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

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

update an existing lag-interface
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

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

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

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

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

update an existing l3-interface-ipv4-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

update an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

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

update an existing sriov-vf
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

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

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

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

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

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

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

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

update an existing l3-interface-ipv6-address-list
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

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

update an existing license
PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

create or update an existing vf-module

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

update an existing vf-module
PUT /network/instance-groups/instance-group/{id}

create or update an existing instance-group

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

update an existing instance-group
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}

create or update an existing ipsec-configuration

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

update an existing ipsec-configuration
PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

create or update an existing vig-server

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

update an existing vig-server
PUT /network/l3-networks/l3-network/{network-id}

create or update an existing l3-network

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

update an existing l3-network
PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

create or update an existing ctag-assignment

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

update an existing ctag-assignment
PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

create or update an existing segmentation-assignment

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

update an existing segmentation-assignment
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

create or update an existing subnet

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

update an existing subnet
PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

create or update an existing host-route

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

update an existing host-route
PUT /network/lag-links/lag-link/{link-name}

create or update an existing lag-link

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

update an existing lag-link
PUT /network/logical-links/logical-link/{link-name}

create or update an existing logical-link

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

update an existing logical-link
PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

create or update an existing multicast-configuration

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

update an existing multicast-configuration
PUT /network/network-policies/network-policy/{network-policy-id}

create or update an existing network-policy

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

update an existing network-policy
PUT /network/newvces/newvce/{vnf-id2}

create or update an existing newvce

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

update an existing newvce
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

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

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

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

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

update an existing l3-interface-ipv4-address-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

update an existing l3-interface-ipv6-address-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

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

update an existing vlan
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

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

update an existing l3-interface-ipv4-address-list
PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

update an existing l3-interface-ipv6-address-list
PUT /network/physical-links/physical-link/{link-name}

create or update an existing physical-link

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

update an existing physical-link
PUT /network/pnfs/pnf/{pnf-name}

create or update an existing pnf

+
PATCH /network/pnfs/pnf/{pnf-name}

update an existing pnf
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf
PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

create or update an existing route-table-reference

+
PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

update an existing route-table-reference
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

create or update an existing site-pair-set

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

update an existing site-pair-set
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

create or update an existing routing-instance

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

update an existing routing-instance
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

create or update an existing site-pair

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

update an existing site-pair
PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

create or update an existing class-of-service

+
PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

update an existing class-of-service
PUT /network/vces/vce/{vnf-id}

create or update an existing vce

+
PATCH /network/vces/vce/{vnf-id}

update an existing vce
PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

create or update an existing entitlement

+
PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

update an existing entitlement
PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

create or update an existing license

+
PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

update an existing license
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

create or update an existing port-group

+
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

update an existing port-group
PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

create or update an existing cvlan-tag-entry

+
PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

update an existing cvlan-tag-entry
DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

delete an existing relationship

-
GET /network/vip-ipv4-address-list/{vip-ipv4-address}

returns vip-ipv4-address-list

-
PUT /network/vip-ipv4-address-list/{vip-ipv4-address}

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

-
DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}

delete an existing vip-ipv4-address-list

-
PUT /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

delete an existing relationship

-
GET /network/vip-ipv6-address-list/{vip-ipv6-address}

returns vip-ipv6-address-list

-
PUT /network/vip-ipv6-address-list/{vip-ipv6-address}

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

-
DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}

delete an existing vip-ipv6-address-list

-
PUT /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

see node definition for valid relationships

-
DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

delete an existing relationship
PUT /network/vnfcs/vnfc/{vnfc-name}

create or update an existing vnfc

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

update an existing vnfc
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}

create or update an existing vpls-pe

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}

update an existing vpls-pe
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

create or update an existing lag-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

update an existing lag-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

create or update an existing p-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

update an existing p-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

create or update an existing l-interface

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

update an existing l-interface
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

create or update an existing sriov-vf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

update an existing sriov-vf
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

create or update an existing vlan

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

update an existing vlan
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

update an existing l3-interface-ipv4-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

update an existing l3-interface-ipv6-address-list
PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

create or update an existing sriov-pf

+
PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

update an existing sriov-pf
PUT /network/vpn-bindings/vpn-binding/{vpn-id}

create or update an existing vpn-binding

+
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

update an existing vpn-binding
PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

create or update an existing route-target

+
PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

update an existing route-target
PUT /network/zones/zone/{zone-id}

create or update an existing zone

+
PATCH /network/zones/zone/{zone-id}

update an existing zone
+ + + + + + + + + + + + + + + + + + +
+ resource-instance-id + +

Unique id of resource instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+ +
@@ -5432,7 +6204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadata + /metadata
@@ -5602,7 +6374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /metadatum
@@ -5649,7 +6421,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnectorMetadataMetadatum.json)

@@ -5734,6 +6506,110 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing metadatum
+

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

+ Tags: + Business +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -5861,7 +6737,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessConnectorsConnector.json)

@@ -6044,7 +6920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /customers + /customers
@@ -6169,7 +7045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /customer + /customer
@@ -6216,7 +7092,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

customer object that needs to be created or updated

+

customer object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)

@@ -6287,22 +7163,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing customer
-

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

+
update an existing customer
+

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

Tags: Business
-

delete an existing customer

+

update an existing customer

application/json application/xml

+
+
+

customer object that needs to be created or updated.

+

+
+
+
+
+ /customer +
+
+
@@ -6332,22 +7220,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -6379,35 +7251,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

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

+
delete an existing customer
+

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

Tags: Business
-

see node definition for valid relationships

+

delete an existing customer

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -6437,6 +7297,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -6469,22 +7345,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

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

+
see node definition for valid relationships
+

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

Tags: Business
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomer.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -6545,19 +7433,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns service-subscriptions
-

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

+
delete an existing relationship
+

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

Tags: Business
-

returns service-subscriptions

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -6586,36 +7479,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- 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 - - -
@@ -6625,29 +7488,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service-subscriptions -
-
-
- -
default @@ -6670,17 +7510,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns service-subscription
-

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

+
returns service-subscriptions
+

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

Tags: Business
-

returns service-subscription

+

returns service-subscriptions

@@ -6711,22 +7551,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - service-type - - -

Value defined by orchestration to identify this service across ECOMP.

- - path - - string - - - - - - subscriber-name @@ -6783,7 +7607,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /service-subscription + /service-subscriptions
@@ -6812,35 +7636,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing service-subscription
-

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

+
returns service-subscription
+

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

Tags: Business
-

create or update an existing service-subscription

+

returns service-subscription

-
- -

application/json application/xml -

-
-
-

service-subscription object that needs to be created or updated

-

-
-
-
-
- /service-subscription -
-
-
-
@@ -6885,105 +7692,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

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 -

-
-
- - - - - - - - - - - - - - - - - - - + @@ -7003,6 +7731,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /service-subscription +
+
+
+ +
default @@ -7025,17 +7776,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
create or update an existing service-subscription
+

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

Tags: Business
-

see node definition for valid relationships

+

create or update an existing service-subscription

@@ -7044,13 +7795,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

service-subscription object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

- /relationship + /service-subscription
@@ -7130,23 +7881,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
update an existing service-subscription
+

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

Tags: Business
-

delete an existing relationship

+

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

Value defined by orchestration to identify this service across ECOMP.

+

Subscriber name, an alternate way to retrieve a customer.

pathquery string -
- resource-version + subscriber-type -

resource-version for concurrency

+

Subscriber type, a way to provide VID with only the INFRA customers.

 query @@ -6991,7 +7720,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -7223,19 +7986,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns service-instances
-

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

+
delete an existing service-subscription
+

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

Tags: Business
-

returns service-instances

+

delete an existing service-subscription

+
+ +

application/json application/xml +

+
@@ -7282,25 +8050,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - @@ -7319,29 +8073,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service-instances -
-
-
- -
default @@ -7364,17 +8095,356 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns service-instance
-

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

+
see node definition for valid relationships
+

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

Tags: Business
-

returns service-instance

+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscription.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

- 		query - string - - -
- subscriber-type + resource-version -

Subscriber type, a way to provide VID with only the INFRA customers.

+

resource-version for concurrency

 query @@ -7308,6 +8061,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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

@@ -7628,7 +8698,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /service-instance + /service-instance
@@ -7675,7 +8745,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service-instance object that needs to be created or updated

+

service-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

@@ -7777,6 +8847,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing service-instance
+

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

+ Tags: + Business +
+
+
+

update an existing service-instance

+ +
+
+ +

application/json application/xml +

+
+
+

service-instance object that needs to be created or updated.

+

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -8166,7 +9357,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /allotted-resources + /allotted-resources
@@ -8534,7 +9725,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /allotted-resource + /allotted-resource
@@ -8581,7 +9772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

allotted-resource object that needs to be created or updated

+

allotted-resource object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

@@ -8699,6 +9890,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing allotted-resource
+

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

+ Tags: + Business +
+
+
+

update an existing allotted-resource

+ +
+
+ +

application/json application/xml +

+
+
+

allotted-resource object that needs to be created or updated.

+

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -8859,7 +10187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResource.json)

@@ -9442,7 +10770,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tunnel-xconnects + /tunnel-xconnects
@@ -9826,7 +11154,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tunnel-xconnect + /tunnel-xconnect
@@ -9873,7 +11201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

tunnel-xconnect object that needs to be created or updated

+

tunnel-xconnect object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

@@ -10007,6 +11335,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing tunnel-xconnect
+

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

+ Tags: + Business +
+
+
+

update an existing tunnel-xconnect

+ +
+
+ +

application/json application/xml +

+
+
+

tunnel-xconnect object that needs to be created or updated.

+

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -10183,7 +11664,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceAllottedResourcesAllottedResourceTunnelXconnectsTunnelXconnect.json)

@@ -10722,7 +12203,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadata + /metadata
@@ -11029,7 +12510,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /metadatum
@@ -11076,7 +12557,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstanceMetadataMetadatum.json)

@@ -11193,6 +12674,142 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing metadatum
+

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

+ Tags: + Business +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -11352,7 +12969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessCustomersCustomerServiceSubscriptionsServiceSubscriptionServiceInstancesServiceInstance.json)

@@ -11599,7 +13216,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lines-of-business + /lines-of-business
@@ -11694,7 +13311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /line-of-business + /line-of-business
@@ -11741,7 +13358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

line-of-business object that needs to be created or updated

+

line-of-business object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)

@@ -11811,6 +13428,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing line-of-business
+

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

+ Tags: + Business +
+
+
+

update an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+

line-of-business object that needs to be created or updated.

+

+
+
+
+
+ /line-of-business +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + +

Name of the line-of-business (product)

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -11923,7 +13629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessLinesOfBusinessLineOfBusiness.json)

@@ -12106,7 +13812,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /owning-entities + /owning-entities
@@ -12201,7 +13907,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /owning-entity + /owning-entity
@@ -12248,7 +13954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

owning-entity object that needs to be created or updated

+

owning-entity object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)

@@ -12319,22 +14025,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing owning-entity
-

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

+
update an existing owning-entity
+

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

Tags: Business
-

delete an existing owning-entity

+

update an existing owning-entity

application/json application/xml

+
+
+

owning-entity object that needs to be created or updated.

+

+
+
+
+
+ /owning-entity +
+
+
@@ -12364,22 +14082,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -12411,35 +14113,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

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

+
delete an existing owning-entity
+

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

Tags: Business
-

see node definition for valid relationships

+

delete an existing owning-entity

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + +

UUID of an owning entity

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Business +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessOwningEntitiesOwningEntity.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -12613,7 +14408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /platforms + /platforms
@@ -12708,7 +14503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /platform + /platform
@@ -12755,7 +14550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

platform object that needs to be created or updated

+

platform object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)

@@ -12825,6 +14620,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing platform
+

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

+ Tags: + Business +
+
+
+

update an existing platform

+ +
+
+ +

application/json application/xml +

+
+
+

platform object that needs to be created or updated.

+

+
+
+
+
+ /platform +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + +
+ platform-name + +

Name of the platform

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -12937,7 +14821,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessPlatformsPlatform.json)

@@ -13120,7 +15004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /projects + /projects
@@ -13215,7 +15099,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /project + /project
@@ -13262,7 +15146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

project object that needs to be created or updated

+

project object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)

@@ -13332,6 +15216,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing project
+

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

+ Tags: + Business +
+
+
+

update an existing project

+ +
+
+ +

application/json application/xml +

+
+
+

project object that needs to be created or updated.

+

+
+
+
+
+ /project +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + +

Name of the project deploying a service

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -13444,7 +15417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/BusinessProjectsProject.json)

@@ -13627,7 +15600,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cloud-regions + /cloud-regions
@@ -13768,7 +15741,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cloud-region + /cloud-region
@@ -13815,7 +15788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

cloud-region object that needs to be created or updated

+

cloud-region object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)

@@ -13901,6 +15874,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing cloud-region
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing cloud-region

+ +
+
+ +

application/json application/xml +

+
+
+

cloud-region object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -14123,7 +16201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /availability-zones + /availability-zones
@@ -14280,7 +16358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /availability-zone + /availability-zone
@@ -14327,7 +16405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

availability-zone object that needs to be created or updated

+

availability-zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

@@ -14429,6 +16507,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing availability-zone
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing availability-zone

+ +
+
+ +

application/json application/xml +

+
+
+

availability-zone object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ availability-zone-name + +

Name of the availability zone. Unique across a cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -14573,7 +16772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionAvailabilityZonesAvailabilityZone.json)

@@ -14897,7 +17096,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /dvs-switches + /dvs-switches
@@ -15069,7 +17268,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /dvs-switch + /dvs-switch
@@ -15116,7 +17315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

dvs-switch object that needs to be created or updated

+

dvs-switch object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

@@ -15219,22 +17418,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing dvs-switch
-

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

+
update an existing dvs-switch
+

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

Tags: CloudInfrastructure
-

delete an existing dvs-switch

+

update an existing dvs-switch

application/json application/xml

+
+
+

dvs-switch object that needs to be created or updated.

+

+
+
+
+
+ /dvs-switch +
+
+
@@ -15296,22 +17507,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -15343,35 +17538,160 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing dvs-switch

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ switch-name + +

DVS switch name

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionDvsSwitchesDvsSwitch.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -15686,7 +18006,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /esr-system-info-list + /esr-system-info-list
@@ -15873,7 +18193,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /esr-system-info + /esr-system-info
@@ -15920,7 +18240,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

esr-system-info object that needs to be created or updated

+

esr-system-info object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)

@@ -16022,6 +18342,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing esr-system-info
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing esr-system-info

+ +
+
+ +

application/json application/xml +

+
+
+

esr-system-info object that needs to be created or updated.

+

+
+
+
+
+ /esr-system-info +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ esr-system-info-id + +

Unique ID of esr system info.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -16166,7 +18607,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionEsrSystemInfoListEsrSystemInfo.json)

@@ -16490,7 +18931,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /flavors + /flavors
@@ -16662,7 +19103,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /flavor + /flavor
@@ -16709,7 +19150,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

flavor object that needs to be created or updated

+

flavor object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

@@ -16812,16 +19253,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing flavor
-

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

+
update an existing flavor
+

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

Tags: CloudInfrastructure
-

delete an existing flavor

+

update an existing flavor

+ +
+
+ +

application/json application/xml +

+
+
+

flavor object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ flavor-id + +

Flavor id, expected to be unique across cloud-region.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing flavor
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing flavor

@@ -16955,7 +19517,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

@@ -17279,7 +19841,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /group-assignments + /group-assignments
@@ -17466,7 +20028,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /group-assignment + /group-assignment
@@ -17513,7 +20075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

group-assignment object that needs to be created or updated

+

group-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

@@ -17616,22 +20178,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing group-assignment
-

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

+
update an existing group-assignment
+

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

Tags: CloudInfrastructure
-

delete an existing group-assignment

+

update an existing group-assignment

application/json application/xml

+
+
+

group-assignment object that needs to be created or updated.

+

+
+
+
+
+ /group-assignment +
+
+
@@ -17693,22 +20267,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -17740,35 +20298,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing group-assignment

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -17830,107 +20376,244 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

- 		path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

- 		path - string - - - -
- group-id + resource-version -

Group id, expected to be unique across cloud-region.

+

resource-version for concurrency

pathquery + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ group-id + +

Group id, expected to be unique across cloud-region.

+ 		path string @@ -18083,7 +20766,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /images + /images
@@ -18300,7 +20983,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /image + /image
@@ -18347,7 +21030,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

image object that needs to be created or updated

+

image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

@@ -18450,22 +21133,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing image
-

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

+
update an existing image
+

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

Tags: CloudInfrastructure
-

delete an existing image

+

update an existing image

application/json application/xml

+
+
+

image object that needs to be created or updated.

+

+
+
+
+
+ /image +
+
+
@@ -18527,22 +21222,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing image
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing image

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -18763,7 +21567,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadata + /metadata
@@ -18995,7 +21799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /metadatum
@@ -19042,7 +21846,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImageMetadataMetadatum.json)

@@ -19160,22 +21964,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing metadatum
-

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

+
update an existing metadatum
+

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

Tags: CloudInfrastructure
-

delete an existing metadatum

+

update an existing metadatum

application/json application/xml

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
@@ -19252,22 +22068,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -19299,35 +22099,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing metadatum

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -19389,89 +22177,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - + + + + + +
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

- 		path - string - - - -
- cloud-region-id + metaname -

Identifier used by the vendor for the region. Second part of composite key

 path @@ -19484,12 +22194,242 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- image-id + resource-version -

Image id, expected to be unique across cloud region

+

resource-version for concurrency

pathquery + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionImagesImage.json)

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ image-id + +

Image id, expected to be unique across cloud region

+ 		path string @@ -19642,7 +22582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /oam-networks + /oam-networks
@@ -19829,7 +22769,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /oam-network + /oam-network
@@ -19876,7 +22816,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

oam-network object that needs to be created or updated

+

oam-network object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

@@ -19979,22 +22919,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing oam-network
-

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

+
update an existing oam-network
+

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

Tags: CloudInfrastructure
-

delete an existing oam-network

+

update an existing oam-network

application/json application/xml

+
+
+

oam-network object that needs to be created or updated.

+

+
+
+
+
+ /oam-network +
+
+
@@ -20056,22 +23008,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing oam-network
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ network-uuid + +

UUID of the network. Unique across a cloud-region

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -20122,7 +23183,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

@@ -20352,7 +23413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegion.json)

@@ -20644,7 +23705,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /snapshots + /snapshots
@@ -20876,7 +23937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /snapshot + /snapshot
@@ -20923,7 +23984,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

snapshot object that needs to be created or updated

+

snapshot object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

@@ -21026,141 +24087,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing snapshot
-

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

+
update an existing snapshot
+

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

Tags: CloudInfrastructure
-

delete an existing snapshot

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

- 		path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

- 		path - string - - - -
- snapshot-id - -

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

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

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

+

update an existing snapshot

@@ -21169,13 +24105,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

snapshot object that needs to be created or updated.

- /relationship + /snapshot
@@ -21271,17 +24207,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

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

+

delete an existing snapshot

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ snapshot-id + +

Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

@@ -21493,7 +24675,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tenants + /tenants
@@ -21680,7 +24862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tenant + /tenant
@@ -21727,7 +24909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

tenant object that needs to be created or updated

+

tenant object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

@@ -21830,22 +25012,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing tenant
-

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

+
update an existing tenant
+

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

Tags: CloudInfrastructure
-

delete an existing tenant

+

update an existing tenant

application/json application/xml

+
+
+

tenant object that needs to be created or updated.

+

+
+
+
+
+ /tenant +
+
+
@@ -21907,22 +25101,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -21954,35 +25132,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing tenant
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing tenant

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -22044,6 +25210,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -22076,22 +25258,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing relationship
-

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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -22184,19 +25378,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vservers
-

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

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

returns vservers

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -22257,66 +25456,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- 		query - string - - -
- tenant-name - -

Readable name of tenant

- 		query - string - - -
- tenant-context - -

This field will store the tenant context.

- 		query - string - - -
@@ -22326,29 +25465,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vservers -
-
-
- -
default @@ -22371,17 +25487,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vserver
-

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

+
returns vservers
+

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

Tags: CloudInfrastructure
-

returns vserver

+

returns vservers

@@ -22444,22 +25560,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-id - -

Unique identifier for this vserver relative to its tenant

- 		path - string - - - -
cloud-type @@ -22520,79 +25620,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -22619,7 +25646,283 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vserver + /vservers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + +
+
+ + +
+
+
returns vserver
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vserver

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ tenant-name + +

Readable name of tenant

+ 		query + string + + +
+ tenant-context + +

This field will store the tenant context.

+ 		query + string + + +
+ vserver-name + +

Name of vserver

+ 		query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vserver
@@ -22666,7 +25969,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vserver object that needs to be created or updated

+

vserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

@@ -22784,6 +26087,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing vserver
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vserver

+ +
+
+ +

application/json application/xml +

+
+
+

vserver object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -23173,7 +26613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /l-interfaces
@@ -23510,7 +26950,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /l-interface
@@ -23557,7 +26997,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

@@ -23691,6 +27131,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing l-interface
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -24218,7 +27811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -24265,7 +27858,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -24415,6 +28008,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing l3-interface-ipv4-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -24607,7 +28369,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -25284,7 +29046,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -25331,7 +29093,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -25482,22 +29244,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

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

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

Tags: CloudInfrastructure
-

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

+

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 +
+
+
@@ -25607,22 +29381,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -25654,35 +29412,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -25792,6 +29538,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -25824,22 +29586,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -25980,35 +29754,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -26102,137 +29864,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

- 		path - string - - - -
- cloud-region-id - -

Identifier used by the vendor for the region. Second part of composite key

- 		path - string - - - -
- tenant-id - -

Unique id relative to the cloud-region.

- 		path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

- 		path - string - - - -
- interface-name + l3-interface-ipv6-address -

Name given to the interface

+

IP address

 path @@ -26274,17 +29911,311 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

returns sriov-vfs

+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vfs
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vfs

@@ -26583,7 +30514,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /sriov-vfs
@@ -26996,7 +30927,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /sriov-vf
@@ -27043,7 +30974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -27194,22 +31125,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

+
update an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -27319,22 +31262,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -27366,35 +31293,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing sriov-vf

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -27504,6 +31419,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -27536,22 +31467,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -27692,19 +31635,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

returns vlans

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -27799,180 +31747,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -27984,29 +31770,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -28029,17 +31792,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

returns vlans

@@ -28134,22 +31897,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- 		query - string - - -
- tenant-name - -

Readable name of tenant

- 		query - string - - -
- tenant-context - -

This field will store the tenant context.

- 		query - string - - -
- vserver-name - -

Name of vserver

- 		query - string - - -
- vserver-name2 - -

Alternative name of vserver

- 		query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- 		query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name + pci-id -

Name of the network

+

PCI ID used to identify the sriov-vf

querypath string +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
cloud-type @@ -28328,36 +32075,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
@@ -28384,7 +32101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /vlans
@@ -28413,35 +32130,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

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

create or update an existing vlan

+

returns vlan

-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated

-

-
-
-
-
- /vlan -
-
-
-
@@ -28550,169 +32250,205 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+

Type of the cloud (e.g., openstack)

pathquery string -
- cloud-region-id + owner-defined-type -

Identifier used by the vendor for the region. Second part of composite key

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

pathquery string -
- tenant-id + tenant-name -

Unique id relative to the cloud-region.

+

Readable name of tenant

pathquery string -
- vserver-id + tenant-context -

Unique identifier for this vserver relative to its tenant

+

This field will store the tenant context.

pathquery string -
- interface-name + vserver-name -

Name given to the interface

+

Name of vserver

pathquery string -
- vlan-interface + vserver-name2 -

String that identifies the interface

+

Alternative name of vserver

pathquery string -
- resource-version + prov-status -

resource-version for concurrency

+

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 @@ -28720,7 +32456,540 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -29170,7 +33439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -29217,7 +33486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -29384,22 +33653,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

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

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

Tags: CloudInfrastructure
-

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

+

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. First part of composite key should be 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 + + +
@@ -29525,22 +33806,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -29572,35 +33837,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -29726,6 +33979,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -29758,22 +34027,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -29930,17 +34211,190 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

@@ -30346,7 +34800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -30393,7 +34847,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -30560,22 +35014,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

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

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

Tags: CloudInfrastructure
-

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

+

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 +
+
+
@@ -30701,22 +35167,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -30748,35 +35198,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -30902,6 +35340,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -30934,22 +35388,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -31106,35 +35572,208 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

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

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -31451,7 +36090,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

@@ -31942,7 +36581,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /volumes + /volumes
@@ -32234,7 +36873,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /volume + /volume
@@ -32281,7 +36920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

volume object that needs to be created or updated

+

volume object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

@@ -32416,22 +37055,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

+
update an existing volume
+

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

Tags: CloudInfrastructure
-

delete an existing volume

+

update an existing volume

application/json application/xml

+
+
+

volume object that needs to be created or updated.

+

+
+
+
+
+ /volume +
+
+
@@ -32525,22 +37176,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -32572,35 +37207,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing volume

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -32694,6 +37317,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -32726,22 +37365,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -32866,19 +37517,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume-groups
-

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

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

returns volume-groups

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -32925,32 +37581,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + @@ -32962,29 +37636,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volume-groups -
-
-
- -
default @@ -33007,17 +37658,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume-group
-

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

+
returns vip-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

returns volume-group

+

returns vip-ipv4-address-list

@@ -33066,10 +37717,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- cloud-type + tenant-id -

Type of the cloud (e.g., openstack)

+

Unique id relative to the cloud-region.

querypath string +
- owner-defined-type + vserver-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Unique identifier for this vserver relative to its tenant

querypath + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

+ 		path string +
- volume-group-id + vip-ipv4-address -

Unique ID of volume-group.

+

IP address

 path @@ -33112,14 +37763,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-name + vlan-id-inner -

Name of the volume group.

+

Inner VLAN tag

 query - string + integer @@ -33127,10 +37778,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + neutron-network-id -

Heat stack id corresponding to this volume-group

+

Neutron network id of the interface that address belongs to

 query @@ -33142,10 +37793,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + neutron-subnet-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Neutron id of subnet that address belongs to

 query @@ -33181,7 +37832,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /volume-group + /vip-ipv4-address-list
@@ -33209,17 +37860,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

Tags: CloudInfrastructure
-

create or update an existing volume-group

+

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

@@ -33228,13 +37879,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

volume-group object that needs to be created or updated

+

vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

- /volume-group + /vip-ipv4-address-list
@@ -33285,10 +37936,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + vip-ipv4-address -

Unique ID of volume-group.

+

IP address

 path @@ -33330,23 +37981,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing volume-group
-

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

+
update an existing vip-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing volume-group

+

update an existing vip-ipv4-address-list

application/json application/xml

+
+
+

vip-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /vip-ipv4-address-list +
+
+
@@ -33394,10 +38057,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- volume-group-id + vip-ipv4-address -

Unique ID of volume-group.

+

IP address

 path @@ -33408,22 +38071,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -33455,35 +38102,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing vip-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing vip-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -33531,103 +38166,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- volume-group-id - -

Unique ID of volume-group.

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - + - - - - - - - - -
- cloud-owner - -

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

- 		path - string - - - -
- cloud-region-id + vip-ipv4-address -

Identifier used by the vendor for the region. Second part of composite key

+

IP address

 path @@ -33640,12 +38182,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + resource-version -

Unique ID of volume-group.

+

resource-version for concurrency

pathquery string @@ -33685,83 +38227,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns complexes
-

GET /cloud-infrastructure/complexes

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

returns complexes

+

see node definition for valid relationships

- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /complexes -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

+

- -
-
-
-
-
- - -
-
-
returns complex
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns complex

- -
+
+
+
+ /relationship +
+
+
+
@@ -33776,10 +38271,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -33844,29 +38326,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /complex -
-
-
- -
default @@ -33889,35 +38348,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing complex
-

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

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

create or update an existing complex

+

delete an existing relationship

application/json application/xml

-
-
-

complex object that needs to be created or updated

-

-
-
-
-
- /complex -
-
-
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -33792,47 +38287,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code - -

Data center code which can be an alternate way to identify a complex

- 		query - string - - -
- complex-name + cloud-region-id -

Gamma complex name for LCP instance.

+

Identifier used by the vendor for the region. Second part of composite key

querypath string +
- identity-url + vip-ipv4-address -

URL of the keystone identity service

+

IP address

querypath string +
@@ -33933,10 +38380,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -33947,73 +38394,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

Unique identifier for physical location, e.g., CLLI

+

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34026,12 +38412,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vip-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -34071,17 +38457,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pools
-

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

+
returns vip-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

returns ctag-pools

+

returns vip-ipv6-address-list

@@ -34098,10 +38484,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -34114,10 +38500,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code + cloud-region-id -

Data center code which can be an alternate way to identify a complex

+

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ vip-ipv6-address + +

IP address

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

 query @@ -34129,10 +38547,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- complex-name + owner-defined-type -

Gamma complex name for LCP instance.

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -34144,10 +38562,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- identity-url + vlan-id-inner -

URL of the keystone identity service

+

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 @@ -34183,7 +38631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ctag-pools + /vip-ipv6-address-list
@@ -34211,19 +38659,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pool
-

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

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

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

Tags: CloudInfrastructure
-

returns ctag-pool

+

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

+
+ +

application/json application/xml +

+
+
+

vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

+

+
+
+
+
+ /vip-ipv6-address-list +
+
+
+
@@ -34238,10 +38703,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -34254,10 +38719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34270,10 +38735,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + vip-ipv6-address -

Name of the availability zone

+

IP address

 path @@ -34284,51 +38749,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -34338,29 +38758,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-pool -
-
-
- -
default @@ -34383,17 +38780,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing ctag-pool
-

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

+
update an existing vip-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

create or update an existing ctag-pool

+

update an existing vip-ipv6-address-list

@@ -34402,13 +38799,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ctag-pool object that needs to be created or updated

+

vip-ipv6-address-list object that needs to be created or updated.

- /ctag-pool + /vip-ipv6-address-list
@@ -34427,10 +38824,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -34443,10 +38840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34459,10 +38856,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + vip-ipv6-address -

Name of the availability zone

+

IP address

 path @@ -34504,17 +38901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing ctag-pool
-

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

+
delete an existing vip-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing ctag-pool

+

delete an existing vip-ipv6-address-list

@@ -34536,10 +38933,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -34552,10 +38949,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34568,10 +38965,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + vip-ipv6-address -

Name of the availability zone

+

IP address

 path @@ -34629,11 +39026,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: CloudInfrastructure
@@ -34648,7 +39045,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

@@ -34673,10 +39070,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -34689,10 +39086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34705,10 +39102,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + vip-ipv6-address -

Name of the availability zone

+

IP address

 path @@ -34750,11 +39147,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: CloudInfrastructure
@@ -34782,10 +39179,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

 path @@ -34798,10 +39195,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- target-pe + cloud-region-id -

The Target provider edge router

+

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34814,10 +39211,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + vip-ipv6-address -

Name of the availability zone

+

IP address

 path @@ -34859,36 +39256,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
returns volume-groups
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns volume-groups

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -34903,10 +39283,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

 path @@ -34917,6 +39313,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -34926,6 +39352,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volume-groups +
+
+
+ +
default @@ -34948,24 +39397,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
returns volume-group
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns volume-group

-
- -

application/json application/xml -

-
@@ -34980,10 +39424,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + cloud-owner -

Unique identifier for physical location, e.g., CLLI

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -34994,51 +39470,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns network-profiles
-

GET /cloud-infrastructure/network-profiles

- Tags: - CloudInfrastructure -
-
-
-

returns network-profiles

- -
-

application/json application/xml

@@ -35061,7 +39571,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-profiles + /volume-group
@@ -35089,19 +39599,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns network-profile
-

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

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

returns network-profile

+

create or update an existing volume-group

+
+ +

application/json application/xml +

+
+
+

volume-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

+
+
+
+
+ /volume-group +
+
+
+
@@ -35116,10 +39643,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -35139,29 +39698,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /network-profile -
-
-
- -
default @@ -35184,17 +39720,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing network-profile
-

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

+
update an existing volume-group
+

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

Tags: CloudInfrastructure
-

create or update an existing network-profile

+

update an existing volume-group

@@ -35203,13 +39739,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

network-profile object that needs to be created or updated

+

volume-group object that needs to be created or updated.

- /network-profile + /volume-group
@@ -35228,10 +39764,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -35273,17 +39841,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing network-profile
-

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

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

+

delete an existing volume-group

@@ -35305,10 +39873,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -35366,11 +39966,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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

Tags: CloudInfrastructure
@@ -35385,7 +39985,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

@@ -35410,10 +40010,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -35455,11 +40087,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/network-profiles/network-profile/{nm-profile-name}/relationship-list/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
@@ -35487,10 +40119,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nm-profile-name + cloud-owner -

Unique name of network profile.

+

Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname

+ 		path + string + + + +
+ cloud-region-id + +

Identifier used by the vendor for the region. Second part of composite key

+ 		path + string + + + +
+ volume-group-id + +

Unique ID of volume-group.

 path @@ -35532,17 +40196,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns pservers
-

GET /cloud-infrastructure/pservers

+
returns complexes
+

GET /cloud-infrastructure/complexes

Tags: CloudInfrastructure
-

returns pservers

+

returns complexes

@@ -35568,7 +40232,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pservers + /complexes
@@ -35596,17 +40260,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns pserver
-

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

+
returns complex
+

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

Tags: CloudInfrastructure
-

returns pserver

+

returns complex

@@ -35623,10 +40287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -35639,10 +40303,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + data-center-code -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Data center code which can be an alternate way to identify a complex

 query @@ -35654,10 +40318,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + complex-name -

ID of Pserver

+

Gamma complex name for LCP instance.

 query @@ -35669,24 +40333,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- pserver-name2 + identity-url -

alternative pserver name

+

URL of the keystone identity service

 query @@ -35722,7 +40372,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pserver + /complex
@@ -35750,17 +40400,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing pserver
-

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

+
create or update an existing complex
+

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

Tags: CloudInfrastructure
-

create or update an existing pserver

+

create or update an existing complex

@@ -35769,13 +40419,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

pserver object that needs to be created or updated

+

complex object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplex.json)

- /pserver + /complex
@@ -35794,10 +40444,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -35839,23 +40489,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing pserver
-

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

+
update an existing complex
+

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

Tags: CloudInfrastructure
-

delete an existing pserver

+

update an existing complex

application/json application/xml

+
+
+

complex object that needs to be created or updated.

+

+
+
+
+
+ /complex +
+
+
@@ -35871,10 +40533,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

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 @@ -35932,17 +40671,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

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

+
returns ctag-pools
+

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

Tags: CloudInfrastructure
-

returns lag-interfaces

+

returns ctag-pools

@@ -35959,10 +40698,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -35975,10 +40714,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + data-center-code -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Data center code which can be an alternate way to identify a complex

 query @@ -35990,10 +40729,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + complex-name -

ID of Pserver

+

Gamma complex name for LCP instance.

 query @@ -36005,24 +40744,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- pserver-name2 + identity-url -

alternative pserver name

+

URL of the keystone identity service

 query @@ -36058,7 +40783,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /ctag-pools
@@ -36086,17 +40811,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interface
-

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

+
returns ctag-pool
+

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

Tags: CloudInfrastructure
-

returns lag-interface

+

returns ctag-pool

@@ -36113,10 +40838,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -36129,10 +40854,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name that identifies the link aggregate interface

+

The Target provider edge router

 path @@ -36145,54 +40870,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- pserver-id + availability-zone-name -

ID of Pserver

+

Name of the availability zone

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + data-center-code -

alternative pserver name

+

Data center code which can be an alternate way to identify a complex

 query @@ -36204,10 +40901,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + complex-name -

ID of interface

+

Gamma complex name for LCP instance.

 query @@ -36219,10 +40916,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + identity-url -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

URL of the keystone identity service

 query @@ -36258,7 +40955,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /ctag-pool
@@ -36286,17 +40983,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

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

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

+

create or update an existing ctag-pool

@@ -36305,13 +41002,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated

+

ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

- /lag-interface + /ctag-pool
@@ -36330,10 +41027,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -36346,10 +41043,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name that identifies the link aggregate interface

+

The Target provider edge router

+ 		path + string + + + +
+ availability-zone-name + +

Name of the availability zone

 path @@ -36391,23 +41104,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

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

+
update an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

delete an existing lag-interface

+

update an existing ctag-pool

application/json application/xml

+
+
+

ctag-pool object that needs to be created or updated.

+

+
+
+
+
+ /ctag-pool +
+
+
@@ -36423,10 +41148,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -36439,10 +41164,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name that identifies the link aggregate interface

+

The Target provider edge router

 path @@ -36455,12 +41180,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + availability-zone-name -

resource-version for concurrency

+

Name of the availability zone

querypath string @@ -36500,19 +41225,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

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

+
delete an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

returns l-interfaces

+

delete an existing ctag-pool

+
+ +

application/json application/xml +

+
@@ -36527,10 +41257,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -36655,29 +41328,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -36700,19 +41350,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

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

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

returns l-interface

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

+
+
+
+
+ /relationship +
+
+
+
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -36543,10 +41273,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name that identifies the link aggregate interface

+

The Target provider edge router

 path @@ -36559,84 +41289,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + availability-zone-name -

ID of interface

+

Name of the availability zone

querypath string +
- interface-role + resource-version -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

resource-version for concurrency

 query @@ -36644,6 +41316,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -36727,10 +41394,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -36743,10 +41410,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + target-pe -

Name that identifies the link aggregate interface

+

The Target provider edge router

 path @@ -36759,10 +41426,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + availability-zone-name -

Name given to the interface

+

Name of the availability zone

 path @@ -36773,138 +41440,113 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -36916,29 +41558,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -36961,17 +41580,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

see node definition for valid relationships

@@ -36980,13 +41599,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureComplexesComplex.json)

- /l-interface + /relationship
@@ -37005,42 +41624,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 + physical-location-id -

ID of interface

+

Unique identifier for physical location, e.g., CLLI

querypath string +
- macaddr + target-pe -

MAC address for the interface

+

The Target provider edge router

querypath string +
- network-name + availability-zone-name -

Name of the network

+

Name of the availability zone

querypath string +
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + physical-location-id -

Name given to the interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -37082,17 +41669,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete 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 relationship
+

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

Tags: CloudInfrastructure
-

delete an existing l-interface

+

delete an existing relationship

@@ -37114,42 +41701,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + physical-location-id -

Name given to the interface

+

Unique identifier for physical location, e.g., CLLI

 path @@ -37160,22 +41715,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -37207,17 +41746,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns network-profiles
+

GET /cloud-infrastructure/network-profiles

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

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

@@ -37234,58 +41837,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + nm-profile-name -

IP address

+

Unique name of network profile.

 path @@ -37296,185 +41851,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -37501,7 +41877,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /network-profile
@@ -37529,17 +41905,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
create or update an existing network-profile
+

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

Tags: CloudInfrastructure
-

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

+

create or update an existing network-profile

@@ -37548,13 +41924,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

network-profile object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)

- /l3-interface-ipv4-address-list + /network-profile
@@ -37573,58 +41949,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + nm-profile-name -

IP address

+

Unique name of network profile.

 path @@ -37666,23 +41994,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing network-profile
+

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

Tags: CloudInfrastructure
-

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

+

update an existing network-profile

application/json application/xml

+
+
+

network-profile object that needs to be created or updated.

+

+
+
+
+
+ /network-profile +
+
+
@@ -37698,42 +42038,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - + +
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name + nm-profile-name -

Name given to the interface

+

Unique name of network profile.

 path @@ -37744,12 +42052,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- l3-interface-ipv4-address + nm-profile-name -

IP address

+

Unique name of network profile.

 path @@ -37807,11 +42176,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: CloudInfrastructure
@@ -37826,7 +42195,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureNetworkProfilesNetworkProfile.json)

@@ -37851,58 +42220,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + nm-profile-name -

IP address

+

Unique name of network profile.

 path @@ -37944,11 +42265,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: CloudInfrastructure
@@ -37976,58 +42297,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + nm-profile-name -

IP address

+

Unique name of network profile.

 path @@ -38069,17 +42342,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns pservers
+

GET /cloud-infrastructure/pservers

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

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

@@ -38110,54 +42447,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 @@ -38217,126 +42506,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -38363,7 +42532,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /pserver
@@ -38391,17 +42560,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
create or update an existing pserver
+

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

Tags: CloudInfrastructure
-

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

+

create or update an existing pserver

@@ -38410,13 +42579,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

pserver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)

- /l3-interface-ipv6-address-list + /pserver
@@ -38449,12 +42618,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing pserver
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing pserver

+ +
+
+ +

application/json application/xml +

+
+
+

pserver object that needs to be created or updated.

+

+
+
+
+
+ /pserver +
+
+
+
+
+ + + + + + + + + + + + +
- interface-name + hostname -

Name that identifies the link aggregate interface

+

Value from executing hostname on the compute node.

 path @@ -38465,12 +42707,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - + - - - - - - -
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

 path @@ -38483,12 +42786,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -38528,24 +42831,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns lag-interfaces
+

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

Tags: CloudInfrastructure
-

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

+

returns lag-interfaces

-
- -

application/json application/xml -

-
@@ -38576,58 +42874,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -38647,6 +42940,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
default @@ -38669,36 +42985,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns lag-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns lag-interface

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
- interface-name + inv-status -

Name that identifies the link aggregate interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- interface-name + pserver-id -

Name given to the interface

+

ID of Pserver

pathquery string -
- l3-interface-ipv6-address + in-maint -

IP address

pathquery - string + boolean -
- resource-version + pserver-name2 -

resource-version for concurrency

+

alternative pserver name

 query @@ -38635,7 +42929,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -38745,34 +43044,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -38784,6 +43140,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
default @@ -38806,23 +43185,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
create or update an existing lag-interface
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+
+ /lag-interface +
+
+
- interface-name + inv-status -

Name given to the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- l3-interface-ipv6-address + pserver-id -

IP address

+

ID of Pserver

pathquery + 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 -
@@ -38868,38 +43259,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
@@ -38931,17 +43290,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing lag-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing lag-interface

@@ -38950,13 +43309,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

lag-interface object that needs to be created or updated.

- /relationship + /lag-interface
@@ -39005,22 +43364,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
@@ -39052,17 +43395,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing lag-interface
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing lag-interface

@@ -39116,12 +43459,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name given to the interface

+

resource-version for concurrency

pathquery string @@ -39161,17 +43504,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

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

+
returns l-interfaces
+

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

Tags: CloudInfrastructure
-

returns sriov-vfs

+

returns l-interfaces

@@ -39218,22 +43561,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
inv-status @@ -39323,51 +43650,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -39394,7 +43676,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l-interfaces
@@ -39422,17 +43704,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns l-interface
+

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

Tags: CloudInfrastructure
-

returns sriov-vf

+

returns l-interface

@@ -39495,22 +43777,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
inv-status @@ -39645,66 +43911,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -39731,7 +43937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l-interface
@@ -39759,17 +43965,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

create or update an existing l-interface

@@ -39778,13 +43984,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /sriov-vf + /l-interface
@@ -39849,163 +44055,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - - -
@@ -40037,17 +44086,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing l-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing l-interface

@@ -40056,13 +44105,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l-interface object that needs to be created or updated.

- /relationship + /l-interface
@@ -40127,22 +44176,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -40174,17 +44207,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

+

delete an existing l-interface

@@ -40254,12 +44287,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

pathquery string @@ -40299,17 +44332,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

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

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

+

returns l3-interface-ipv4-address-list

@@ -40372,6 +44405,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
inv-status @@ -40506,6 +44555,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -40532,7 +44626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l3-interface-ipv4-address-list
@@ -40560,19 +44654,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

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

returns vlan

+

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

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -40635,10 +44746,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -40649,170 +44760,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -40822,29 +44769,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -40867,17 +44791,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

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

Tags: CloudInfrastructure
-

create or update an existing vlan

+

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

@@ -40886,13 +44810,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /vlan + /l3-interface-ipv4-address-list
@@ -40959,10 +44883,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -41004,17 +44928,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

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

@@ -41084,10 +45008,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -41145,19 +45069,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -41220,10 +45161,119 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

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 @@ -41250,56 +45300,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 + + + +
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the link aggregate interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint + l3-interface-ipv6-address +

IP address

querypath - boolean + string +
- pserver-name2 + inv-status -

alternative pserver name

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -41311,10 +45437,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + pserver-id -

ID of interface

+

ID of Pserver

 query @@ -41326,10 +45452,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + in-maint -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + boolean + + +
+ pserver-name2 + +

alternative pserver name

 query @@ -41356,10 +45496,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + interface-role -

MAC address for the interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -41371,10 +45511,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-id -

Name of the network

+

ID of interface

 query @@ -41386,14 +45526,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + macaddr -

Inner VLAN tag

+

MAC address for the interface

 query - integer + string @@ -41401,10 +45541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + network-name -

This indicates the customers VPN ID associated with this vlan

+

Name of the network

 query @@ -41485,7 +45625,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -41513,17 +45653,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

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

@@ -41532,13 +45672,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -41605,23 +45745,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -41666,23 +45790,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

Tags: CloudInfrastructure
-

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

+

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 +
+
+
@@ -41746,23 +45882,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -41776,22 +45896,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -41823,35 +45927,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -41915,10 +46007,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - -
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -41931,12 +46023,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -41976,23 +46068,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -42056,10 +46160,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

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 @@ -42072,7 +46253,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + 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

@@ -42117,19 +46330,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -42190,12 +46420,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - + + +
- vlan-interface + hostname -

String that identifies the interface

+

Value from executing hostname on the compute node.

 path @@ -42208,10 +46499,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

 path @@ -42224,84 +46515,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name given to the interface

querypath 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

+ +
+
+ + + + + + + + + + + - + - - - - - - - - + - + + + + + + + + + + + + + + +
- pserver-id + hostname -

ID of Pserver

+

Value from executing hostname on the compute node.

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + inv-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -42313,10 +46650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + pserver-id -

ID of interface

+

ID of Pserver

 query @@ -42328,14 +46665,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + in-maint -

MAC address for the interface

 query - string + boolean @@ -42343,10 +46679,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + pserver-name2 -

Name of the network

+

alternative pserver name

 query @@ -42358,14 +46694,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-id -

Inner VLAN tag

+

ID of interface

 query - integer + string @@ -42373,10 +46709,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + interface-role -

This indicates the customers VPN ID associated with this vlan

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -42388,14 +46724,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-id -

Inner VLAN tag

+

ID of interface

 query - integer + string @@ -42403,10 +46739,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + macaddr -

Neutron network id of the interface that address belongs to

+

MAC address for the interface

 query @@ -42418,10 +46754,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + network-name -

Neutron id of subnet that address belongs to

+

Name of the network

 query @@ -42457,7 +46793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /sriov-vfs
@@ -42485,36 +46821,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -42577,10 +46896,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -42593,167 +46912,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + inv-status -

IP address

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery 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 + pserver-id -

Value from executing hostname on the compute node.

+

ID of Pserver

pathquery string -
- interface-name + in-maint -

Name that identifies the link aggregate interface

pathquery - string + boolean -
- interface-name + pserver-name2 -

Name given to the interface

+

alternative pserver name

pathquery string -
- vlan-interface + interface-id -

String that identifies the interface

+

ID of interface

pathquery string -
- l3-interface-ipv6-address + interface-role -

IP address

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

pathquery string -
- resource-version + interface-id -

resource-version for concurrency

+

ID of interface

 query @@ -42761,160 +47012,96 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

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 -
-
-
-
-
- - - - - - - - - - - - + - + - + - + - + + + + + + + + @@ -42926,6 +47113,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -42948,23 +47158,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

delete an existing relationship

+

create or update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
- hostname + macaddr -

Value from executing hostname on the compute node.

+

MAC address for the interface

pathquery string -
- interface-name + network-name -

Name that identifies the link aggregate interface

+

Name of the network

pathquery string -
- interface-name + vf-vlan-filter -

Name given to the interface

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

pathquery string -
- vlan-interface + vf-mac-filter -

String that identifies the interface

+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

pathquery string -
- l3-interface-ipv6-address + vf-vlan-strip -

IP address

+

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

pathquery + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+ 		query string -
@@ -43028,26 +47250,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -43089,17 +47295,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
update an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing sriov-vf

@@ -43108,13 +47314,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

sriov-vf object that needs to be created or updated.

- /relationship + /sriov-vf
@@ -43181,10 +47387,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -43226,17 +47432,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

+

delete an existing sriov-vf

@@ -43306,10 +47512,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -43320,6 +47526,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -43351,11 +47573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

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

+

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
@@ -43370,7 +47592,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -43425,6 +47647,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -43456,11 +47710,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/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
@@ -43518,6 +47772,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -43549,17 +47835,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns p-interfaces
-

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

+
returns vlans
+

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

Tags: CloudInfrastructure
-

returns p-interfaces

+

returns vlans

@@ -43592,43 +47878,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the link aggregate interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint + inv-status +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query - boolean + string @@ -43636,10 +47925,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + pserver-id -

alternative pserver name

+

ID of Pserver

 query @@ -43649,123 +47938,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

Value from executing hostname on the compute node.

pathquery - string + boolean -
- interface-name + pserver-name2 -

Name that identifies the physical interface

+

alternative pserver name

pathquery string -
- inv-status + interface-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of interface

 query @@ -43777,10 +47984,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + interface-role -

ID of Pserver

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -43792,13 +47999,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + interface-id +

ID of interface

 query - boolean + string @@ -43806,10 +48014,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + macaddr -

alternative pserver name

+

MAC address for the interface

 query @@ -43821,10 +48029,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name of the network

 query @@ -43860,7 +48068,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interface + /vlans
@@ -43888,36 +48096,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing p-interface
-

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

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

create or update an existing p-interface

+

returns vlan

-
- -

application/json application/xml -

-
-
-

p-interface object that needs to be created or updated

-

-
-
-
-
- /p-interface -
-
-
-
@@ -43951,7 +48142,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -43962,73 +48153,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

Value from executing hostname on the compute node.

+

Name given to the interface

 path @@ -44041,10 +48171,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name that identifies the physical interface

+

String that identifies the interface

 path @@ -44057,10 +48187,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + inv-status -

resource-version for concurrency

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -44068,103 +48198,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

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

Value from executing hostname on the compute node.

+

ID of Pserver

pathquery string -
- interface-name + in-maint -

Name that identifies the physical interface

pathquery + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query string -
- inv-status + interface-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of interface

 query @@ -44176,10 +48261,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + interface-role -

ID of Pserver

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -44191,13 +48276,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + interface-id +

ID of interface

 query - boolean + string @@ -44205,10 +48291,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + macaddr -

alternative pserver name

+

MAC address for the interface

 query @@ -44220,10 +48306,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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 @@ -44259,7 +48375,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /vlan
@@ -44287,19 +48403,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

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

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

returns l-interface

+

create or update an existing vlan

+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
@@ -44333,7 +48466,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -44488,29 +48518,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -44533,17 +48540,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing vlan
+

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

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

update an existing vlan

@@ -44552,13 +48559,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

vlan object that needs to be created or updated.

- /l-interface + /vlan
@@ -44596,7 +48603,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -44362,121 +48495,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vlan-interface -

Name of the network

+

String that identifies the interface

querypath string +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -44623,6 +48630,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -44654,17 +48677,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete 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 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 l-interface

+

delete an existing vlan

@@ -44705,7 +48728,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -44732,6 +48755,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
resource-version @@ -44779,11 +48818,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -44825,7 +48864,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -44852,6 +48891,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -44929,10 +48984,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -45002,6 +49072,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -45058,7 +49158,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -45086,11 +49186,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -45105,7 +49205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -45149,7 +49249,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -45176,6 +49276,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -45223,11 +49339,164 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
+
+
update an existing l3-interface-ipv4-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -45274,7 +49543,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -45301,6 +49570,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -45364,11 +49649,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -45383,7 +49668,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -45427,7 +49712,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -45454,6 +49739,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -45501,11 +49802,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -45552,7 +49853,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -45579,6 +49880,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -45626,11 +49943,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -45672,7 +49989,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -45699,6 +50016,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -45776,10 +50109,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -45849,6 +50197,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -45905,7 +50283,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -45933,11 +50311,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -45952,7 +50330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -45996,7 +50374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -46023,6 +50401,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -46070,11 +50464,164 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
+
+
update an existing l3-interface-ipv6-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -46121,7 +50668,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -46148,6 +50695,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -46211,11 +50774,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -46230,7 +50793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -46274,7 +50837,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -46301,6 +50864,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -46348,11 +50927,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -46399,7 +50978,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -46426,6 +51005,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -46473,11 +51068,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -46492,7 +51087,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -46536,7 +51131,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -46563,6 +51158,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -46594,11 +51205,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
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

+

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
@@ -46645,7 +51256,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -46672,6 +51283,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -46703,19 +51330,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vfs
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

returns sriov-vfs

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -46749,23 +51393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -46776,125 +51404,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -46904,29 +51413,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -46949,19 +51435,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

returns sriov-vf

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -46995,23 +51486,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - + +
-

Name that identifies the physical interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -47022,12 +51497,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + +
- pci-id + hostname -

PCI ID used to identify the sriov-vf

+

Value from executing hostname on the compute node.

 path @@ -47097,42 +51628,123 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - -
- prov-status + hostname -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Value from executing hostname on the compute node.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the physical interface

querypath string +
- macaddr + inv-status -

MAC address for the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -47144,10 +51756,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + pserver-id -

Name of the network

+

ID of Pserver

 query @@ -47159,14 +51771,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + in-maint -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query - string + boolean @@ -47174,10 +51785,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + pserver-name2 -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

alternative pserver name

 query @@ -47189,25 +51800,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + prov-status -

Neutron network id of the interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -47243,7 +51839,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /p-interface
@@ -47271,17 +51867,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

create or update an existing p-interface

@@ -47290,13 +51886,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

- /sriov-vf + /p-interface
@@ -47345,38 +51941,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -47408,23 +51972,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing p-interface
+

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

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

update an existing p-interface

application/json application/xml

+
+
+

p-interface object that needs to be created or updated.

+

+
+
+
+
+ /p-interface +
+
+
@@ -47470,54 +52046,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
@@ -47549,35 +52077,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing p-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing p-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -47625,28 +52141,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

pathquery string @@ -47686,24 +52186,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns l-interfaces
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -47748,142 +52243,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - -
- 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 @@ -47958,51 +52317,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -48029,7 +52343,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l-interfaces
@@ -48057,17 +52371,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

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

+
returns l-interface
+

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

Tags: CloudInfrastructure
-

returns vlan

+

returns l-interface

@@ -48130,22 +52444,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
inv-status @@ -48265,36 +52563,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
@@ -48321,7 +52589,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l-interface
@@ -48349,17 +52617,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

create or update an existing l-interface

@@ -48368,13 +52636,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

- /vlan + /l-interface
@@ -48439,22 +52707,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -48486,23 +52738,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing l-interface
+

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

Tags: CloudInfrastructure
-

delete an existing vlan

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -48564,12 +52828,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + hostname -

String that identifies the interface

+

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 @@ -48627,11 +52984,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -48700,22 +53057,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -48866,36 +53207,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 @@ -48952,7 +53263,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -48980,11 +53291,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -48999,7 +53310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -49070,22 +53381,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -49133,23 +53428,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

Tags: CloudInfrastructure
-

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

+

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 +
+
+
@@ -49211,22 +53518,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -49243,22 +53534,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -49290,35 +53565,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -49382,10 +53645,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -49398,12 +53661,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -49443,23 +53706,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -49521,22 +53796,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -49584,19 +53843,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -49659,10 +53923,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -49673,12 +53937,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- l3-interface-ipv6-address + hostname -

IP address

+

Value from executing hostname on the compute node.

 path @@ -49691,54 +54011,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the physical interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint + l3-interface-ipv6-address +

IP address

querypath - boolean + string +
- pserver-name2 + inv-status -

alternative pserver name

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -49750,10 +54074,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + pserver-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

ID of Pserver

 query @@ -49765,10 +54089,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + in-maint -

ID of interface

+ 		query + boolean + + +
+ pserver-name2 + +

alternative pserver name

 query @@ -49780,10 +54118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + prov-status -

MAC address for the interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -49795,10 +54133,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-id -

Name of the network

+

ID of interface

 query @@ -49810,14 +54148,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + macaddr -

Inner VLAN tag

+

MAC address for the interface

 query - integer + string @@ -49825,10 +54163,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + network-name -

This indicates the customers VPN ID associated with this vlan

+

Name of the network

 query @@ -49909,7 +54247,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -49937,11 +54275,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -49956,7 +54294,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -50027,22 +54365,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -50090,23 +54412,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

Tags: CloudInfrastructure
-

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

+

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 +
+
+
@@ -50168,22 +54502,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -50200,22 +54518,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -50247,35 +54549,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

see node definition for valid relationships

+

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

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -50339,10 +54629,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -50355,12 +54645,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -50400,23 +54690,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -50478,22 +54780,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -50541,35 +54827,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -50633,10 +54907,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - -
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -50678,23 +54952,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -50756,22 +55042,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -50803,35 +55073,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -50877,6 +55135,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
@@ -50908,24 +55182,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

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

delete an existing relationship

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -50970,68 +55239,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

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

Value from executing hostname on the compute node.

+

Name given to the interface

 path @@ -51044,26 +55257,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + inv-status -

Name that identifies the physical interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- inv-status + pserver-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of Pserver

 query @@ -51075,10 +55287,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + in-maint -

ID of Pserver

+ 		query + boolean + + +
+ pserver-name2 + +

alternative pserver name

 query @@ -51090,13 +55316,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + prov-status +

Trigger for operational monitoring of this resource by Service Assurance systems.

 query - boolean + string @@ -51104,10 +55331,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + interface-id -

alternative pserver name

+

ID of interface

 query @@ -51119,10 +55346,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + macaddr -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

 query @@ -51158,7 +55400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-pfs + /sriov-vfs
@@ -51186,17 +55428,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-pf
-

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

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

+

returns sriov-vf

@@ -51245,10 +55487,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + interface-name -

Identifier for the sriov-pf

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -51333,6 +55591,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -51359,7 +55722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-pf + /sriov-vf
@@ -51387,17 +55750,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

create or update an existing sriov-vf

@@ -51406,13 +55769,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-pf object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /sriov-pf + /sriov-vf
@@ -51463,10 +55826,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + interface-name -

Identifier for the sriov-pf

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -51508,23 +55887,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-pf
-

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

+
update an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

delete an existing sriov-pf

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -51572,10 +55963,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pf-pci-id + interface-name -

Identifier for the sriov-pf

+

Name given to the interface

 path @@ -51588,12 +55979,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -51633,35 +56024,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

see node definition for valid relationships

+

delete an existing sriov-vf

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -51709,10 +56088,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- pf-pci-id + interface-name -

Identifier for the sriov-pf

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -51723,6 +56118,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -51754,23 +56165,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

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

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -51818,10 +56241,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- pf-pci-id + interface-name -

Identifier for the sriov-pf

+

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -51863,35 +56302,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -51921,6 +56348,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
@@ -51952,24 +56427,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

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

+
returns vlans
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns vlans

-
- -

application/json application/xml -

-
@@ -51998,51 +56468,161 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ 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 -

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

@@ -52065,7 +56645,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /virtual-data-centers + /vlans
@@ -52093,17 +56673,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns virtual-data-center
-

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

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

+

returns vlan

@@ -52120,10 +56700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + hostname -

Unique ID of the vdc

+

Value from executing hostname on the compute node.

 path @@ -52136,10 +56716,192 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-name + interface-name -

Name of the virtual data center

+

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 @@ -52175,7 +56937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /virtual-data-center + /vlan
@@ -52203,17 +56965,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing virtual-data-center
-

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

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

+

create or update an existing vlan

@@ -52222,13 +56984,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

virtual-data-center object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /virtual-data-center + /vlan
@@ -52247,10 +57009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + hostname -

Unique ID of the vdc

+

Value from executing hostname on the compute node.

 path @@ -52261,73 +57023,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

Unique ID of the vdc

+

Name that identifies the physical interface

 path @@ -52340,12 +57041,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string @@ -52385,17 +57102,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
update an existing vlan
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing vlan

@@ -52404,13 +57121,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

vlan object that needs to be created or updated.

- /relationship + /vlan
@@ -52429,10 +57146,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + hostname -

Unique ID of the vdc

+

Value from executing hostname on the compute node.

 path @@ -52443,73 +57160,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

Unique ID of the vdc

+

Name that identifies the physical interface

 path @@ -52520,132 +57176,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns esr-ems-list
-

GET /external-system/esr-ems-list

- Tags: - ExternalSystem -
-
-
-

returns esr-ems-list

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-ems-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns esr-ems
-

GET /external-system/esr-ems-list/esr-ems/{ems-id}

- Tags: - ExternalSystem -
-
-
-

returns esr-ems

- -
-
- - - - - - - - - - - - -
- ems-id + interface-name -

Unique ID of EMS.

+

Name given to the interface

 path @@ -52656,108 +57192,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-ems -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing esr-ems
-

PUT /external-system/esr-ems-list/esr-ems/{ems-id}

- Tags: - ExternalSystem -
-
-
-

create or update an existing esr-ems

- -
-
- -

application/json application/xml -

-
-
-

esr-ems object that needs to be created or updated

-

-
-
-
-
- /esr-ems -
-
-
-
-
- - - - - - - - - - - - + + + + + + + + - -
- ems-id + vlan-interface -

Unique ID of EMS.

+

String that identifies the interface

 path @@ -52799,17 +57239,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing esr-ems
-

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}

+
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: - ExternalSystem + CloudInfrastructure
-

delete an existing esr-ems

+

delete an existing vlan

@@ -52831,10 +57271,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + hostname -

Unique ID of EMS.

+

Value from executing hostname on the compute node.

 path @@ -52847,12 +57287,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path string @@ -52861,68 +57317,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns esr-system-info-list
-

GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list

- Tags: - ExternalSystem -
-
-
-

returns esr-system-info-list

- -
-
- - - - - - - - - - - + + + + + + +
- ems-id + vlan-interface -

Unique ID of EMS.

+

String that identifies the interface

 path @@ -52933,6 +57333,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -52942,29 +57358,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-system-info-list -
-
-
- -
default @@ -52987,17 +57380,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns esr-system-info
-

GET /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

returns esr-system-info

+

returns l3-interface-ipv4-address-list

@@ -53014,10 +57407,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + hostname -

Unique ID of EMS.

+

Value from executing hostname on the compute node.

 path @@ -53030,10 +57423,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

 path @@ -53046,35 +57439,247 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- system-name + interface-name -

name of external system.

+

Name given to the interface

querypath string +
- system-type + vlan-interface -

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+

String that identifies the interface

querypath 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 + + +
@@ -53100,7 +57705,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /esr-system-info + /l3-interface-ipv4-address-list
@@ -53128,17 +57733,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing esr-system-info
-

PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

create or update an existing esr-system-info

+

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

@@ -53147,13 +57752,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

esr-system-info object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /esr-system-info + /l3-interface-ipv4-address-list
@@ -53172,10 +57777,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + hostname -

Unique ID of EMS.

+

Value from executing hostname on the compute node.

 path @@ -53188,10 +57793,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

 path @@ -53202,73 +57807,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing esr-system-info
-

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

- Tags: - ExternalSystem -
-
-
-

delete an existing esr-system-info

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- ems-id + interface-name -

Unique ID of EMS.

+

Name given to the interface

 path @@ -53281,10 +57825,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + vlan-interface -

Unique ID of esr system info.

+

String that identifies the interface

 path @@ -53297,12 +57841,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -53342,17 +57886,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

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

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

Tags: - ExternalSystem + CloudInfrastructure
-

see node definition for valid relationships

+

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

@@ -53361,13 +57905,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -53386,10 +57930,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + hostname -

Unique ID of EMS.

+

Value from executing hostname on the compute node.

 path @@ -53402,10 +57946,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

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 @@ -53447,17 +58039,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

+
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: - ExternalSystem + CloudInfrastructure
-

delete an existing relationship

+

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

@@ -53479,10 +58071,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + hostname -

Unique ID of EMS.

+

Value from executing hostname on the compute node.

 path @@ -53495,10 +58087,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

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 @@ -53509,6 +58149,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -53540,13 +58196,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/relationship

+

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: - ExternalSystem + CloudInfrastructure
@@ -53559,7 +58215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -53584,10 +58240,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + 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 -

Unique ID of EMS.

+

IP address

 path @@ -53629,13 +58349,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /external-system/esr-ems-list/esr-ems/{ems-id}/relationship-list/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: - ExternalSystem + CloudInfrastructure
@@ -53661,10 +58381,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ems-id + 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 -

Unique ID of EMS.

+

IP address

 path @@ -53706,81 +58490,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
returns esr-thirdparty-sdnc-list
-

GET /external-system/esr-thirdparty-sdnc-list

- Tags: - ExternalSystem -
-
-
-

returns esr-thirdparty-sdnc-list

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-thirdparty-sdnc-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
+ +
-
returns esr-thirdparty-sdnc
-

GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

+
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: - ExternalSystem + CloudInfrastructure
-

returns esr-thirdparty-sdnc

+

returns l3-interface-ipv6-address-list

@@ -53797,10 +58517,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + 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 -

Unique ID of SDNC.

+

IP address

 path @@ -53811,6 +58595,200 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -53837,7 +58815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /esr-thirdparty-sdnc + /l3-interface-ipv6-address-list
@@ -53865,17 +58843,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing esr-thirdparty-sdnc
-

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

+
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: - ExternalSystem + CloudInfrastructure
-

create or update an existing esr-thirdparty-sdnc

+

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

@@ -53884,13 +58862,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

esr-thirdparty-sdnc object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /esr-thirdparty-sdnc + /l3-interface-ipv6-address-list
@@ -53909,10 +58887,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -53923,73 +58901,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing esr-thirdparty-sdnc
-

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}

- Tags: - ExternalSystem -
-
-
-

delete an existing esr-thirdparty-sdnc

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- thirdparty-sdnc-id + interface-name -

Unique ID of SDNC.

+

Name that identifies the physical interface

 path @@ -54002,12 +58919,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -54047,19 +58996,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns esr-system-info-list
-

GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list

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

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

Tags: - ExternalSystem + CloudInfrastructure
-

returns esr-system-info-list

+

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 +
+
+
+
@@ -54074,10 +59040,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -54088,38 +59054,79 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
+ 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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-system-info-list -
-
-
- -
default @@ -54142,19 +59149,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns esr-system-info
-

GET /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

returns esr-system-info

+

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

+
+ +

application/json application/xml +

+
@@ -54169,10 +59181,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -54238,29 +59284,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-system-info -
-
-
- -
default @@ -54283,17 +59306,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing esr-system-info
-

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

create or update an existing esr-system-info

+

see node definition for valid relationships

@@ -54302,13 +59325,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

esr-system-info object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /esr-system-info + /relationship
@@ -54327,10 +59350,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -54185,10 +59197,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

 path @@ -54201,25 +59213,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- system-name + interface-name -

name of external system.

+

Name given to the interface

querypath string +
- system-type + vlan-interface -

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

 query @@ -54227,6 +59272,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -54343,10 +59366,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

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 @@ -54388,17 +59459,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing esr-system-info
-

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

delete an existing esr-system-info

+

delete an existing relationship

@@ -54420,10 +59491,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -54436,10 +59507,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

 path @@ -54452,12 +59523,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -54497,13 +59600,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/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

Tags: - ExternalSystem + CloudInfrastructure
@@ -54516,7 +59619,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -54541,10 +59644,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -54557,10 +59660,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

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 @@ -54602,13 +59737,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/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: - ExternalSystem + CloudInfrastructure
@@ -54634,10 +59769,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + hostname -

Unique ID of SDNC.

+

Value from executing hostname on the compute node.

 path @@ -54650,10 +59785,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

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 @@ -54695,13 +59862,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

+

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

Tags: - ExternalSystem + CloudInfrastructure
@@ -54714,7 +59881,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

@@ -54739,10 +59906,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name -

Unique ID of SDNC.

+

Name that identifies the physical interface

 path @@ -54784,13 +59967,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /external-system/esr-thirdparty-sdnc-list/esr-thirdparty-sdnc/{thirdparty-sdnc-id}/relationship-list/relationship

+

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

Tags: - ExternalSystem + CloudInfrastructure
@@ -54816,10 +59999,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- thirdparty-sdnc-id + hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name -

Unique ID of SDNC.

+

Name that identifies the physical interface

 path @@ -54861,81 +60060,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
returns esr-vnfm-list
-

GET /external-system/esr-vnfm-list

- Tags: - ExternalSystem -
-
-
-

returns esr-vnfm-list

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-vnfm-list -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
+ +
-
returns esr-vnfm
-

GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

+
returns sriov-pfs
+

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

Tags: - ExternalSystem + CloudInfrastructure
-

returns esr-vnfm

+

returns sriov-pfs

@@ -54952,10 +60087,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfm-id + hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name -

Unique ID of VNFM.

+

Name that identifies the physical interface

 path @@ -54966,6 +60117,80 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -54992,7 +60217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /esr-vnfm + /sriov-pfs
@@ -55020,36 +60245,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing esr-vnfm
-

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

+
returns sriov-pf
+

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

Tags: - ExternalSystem + CloudInfrastructure
-

create or update an existing esr-vnfm

+

returns sriov-pf

-
- -

application/json application/xml -

-
-
-

esr-vnfm object that needs to be created or updated

-

-
-
-
-
- /esr-vnfm -
-
-
-
@@ -55064,10 +60272,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55078,73 +60286,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing esr-vnfm
-

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}

- Tags: - ExternalSystem -
-
-
-

delete an existing esr-vnfm

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - -
- vnfm-id + interface-name -

Unique ID of VNFM.

+

Name that identifies the physical interface

 path @@ -55157,12 +60304,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pf-pci-id -

resource-version for concurrency

+

Identifier for the sriov-pf

querypath string @@ -55171,76 +60318,78 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns esr-system-info-list
-

GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list

- Tags: - ExternalSystem -
-
-
-

returns esr-system-info-list

- -
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -55269,7 +60418,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /esr-system-info-list + /sriov-pf
@@ -55297,19 +60446,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns esr-system-info
-

GET /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

returns esr-system-info

+

create or update an existing sriov-pf

+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

+

+
+
+
+
+ /sriov-pf +
+
+
+
- vnfm-id + inv-status -

Unique ID of VNFM.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery + 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 -
@@ -55324,10 +60490,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -55393,29 +60545,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /esr-system-info -
-
-
- -
default @@ -55438,17 +60567,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing esr-system-info
-

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
update an existing sriov-pf
+

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

Tags: - ExternalSystem + CloudInfrastructure
-

create or update an existing esr-system-info

+

update an existing sriov-pf

@@ -55457,13 +60586,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

esr-system-info object that needs to be created or updated

+

sriov-pf object that needs to be created or updated.

- /esr-system-info + /sriov-pf
@@ -55482,10 +60611,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55340,10 +60506,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

 path @@ -55356,32 +60522,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- system-name - -

name of external system.

- 		query - string - - -
- system-type + pf-pci-id -

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+

Identifier for the sriov-pf

querypath string +
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55498,10 +60627,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

 path @@ -55543,17 +60688,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing esr-system-info
-

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}

+
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: - ExternalSystem + CloudInfrastructure
-

delete an existing esr-system-info

+

delete an existing sriov-pf

@@ -55575,10 +60720,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55591,10 +60736,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

 path @@ -55652,13 +60813,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

+

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

Tags: - ExternalSystem + CloudInfrastructure
@@ -55671,7 +60832,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserverPInterfacesPInterfaceSriovPfsSriovPf.json)

@@ -55696,10 +60857,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55712,10 +60873,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

 path @@ -55757,13 +60934,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

+

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

Tags: - ExternalSystem + CloudInfrastructure
@@ -55789,10 +60966,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55805,10 +60982,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- esr-system-info-id + interface-name -

Unique ID of esr system info.

+

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

 path @@ -55850,13 +61043,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

+

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

Tags: - ExternalSystem + CloudInfrastructure
@@ -55869,7 +61062,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructurePserversPserver.json)

@@ -55894,10 +61087,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -55939,13 +61132,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /external-system/esr-vnfm-list/esr-vnfm/{vnfm-id}/relationship-list/relationship

+

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

Tags: - ExternalSystem + CloudInfrastructure
@@ -55971,10 +61164,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfm-id + hostname -

Unique ID of VNFM.

+

Value from executing hostname on the compute node.

 path @@ -56016,17 +61209,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns generic-vnfs
-

GET /network/generic-vnfs

+
returns virtual-data-centers
+

GET /cloud-infrastructure/virtual-data-centers

Tags: - Network + CloudInfrastructure
-

returns generic-vnfs

+

returns virtual-data-centers

@@ -56052,7 +61245,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /generic-vnfs + /virtual-data-centers
@@ -56080,17 +61273,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns generic-vnf
-

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

+
returns virtual-data-center
+

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

Tags: - Network + CloudInfrastructure
-

returns generic-vnf

+

returns virtual-data-center

@@ -56107,10 +61300,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vdc-id -

Unique id of VNF. This is unique across the graph.

+

Unique ID of the vdc

 path @@ -56123,248 +61316,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 + vdc-name -

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

+

Name of the virtual data center

 query @@ -56400,7 +61355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /generic-vnf + /virtual-data-center
@@ -56428,17 +61383,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing generic-vnf
-

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

+
create or update an existing virtual-data-center
+

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

Tags: - Network + CloudInfrastructure
-

create or update an existing generic-vnf

+

create or update an existing virtual-data-center

@@ -56447,13 +61402,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

generic-vnf object that needs to be created or updated

+

virtual-data-center object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

- /generic-vnf + /virtual-data-center
@@ -56472,10 +61427,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vdc-id -

Unique id of VNF. This is unique across the graph.

+

Unique ID of the vdc

 path @@ -56517,23 +61472,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing generic-vnf
-

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

+
update an existing virtual-data-center
+

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

Tags: - Network + CloudInfrastructure
-

delete an existing generic-vnf

+

update an existing virtual-data-center

application/json application/xml

+
+
+

virtual-data-center object that needs to be created or updated.

+

+
+
+
+
+ /virtual-data-center +
+
+
@@ -56549,10 +61516,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vnf-id + vdc-id -

Unique id of VNF. This is unique across the graph.

+

Unique ID of the vdc

 path @@ -56563,22 +61530,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -56610,19 +61561,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns entitlements
-

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

+
delete an existing virtual-data-center
+

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

Tags: - Network + CloudInfrastructure
-

returns entitlements

+

delete an existing virtual-data-center

+
+ +

application/json application/xml +

+
@@ -56637,10 +61593,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- vnf-id + vdc-id -

Unique id of VNF. This is unique across the graph.

+

Unique ID of the vdc

 path @@ -56653,218 +61609,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + resource-version -

English description of Network function that the specific VNF deployment is providing

+

resource-version for concurrency

 query @@ -56872,42 +61620,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/CloudInfrastructureVirtualDataCentersVirtualDataCenter.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + + +
- nf-role + vdc-id -

role in the network that this model will be providing

+

Unique ID of the vdc

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

+
+
+ + + + + + + + + + + - +
- nf-naming-code + vdc-id -

string assigned to this model used for naming purposes

+

Unique ID of the vdc

querypath string +
+
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns configurations
+

GET /network/configurations

+ Tags: + Network +
+
+
+

returns configurations

+ +
+

application/json application/xml

@@ -56930,7 +61856,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlements + /configurations
@@ -56958,17 +61884,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns entitlement
-

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

+
returns configuration
+

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

Tags: Network
-

returns entitlement

+

returns configuration

@@ -56985,42 +61911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + configuration-id -

Unique ID of an entitlement resource.

+

UUID assigned to configuration.

 path @@ -57031,139 +61925,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 @@ -57194,96 +61955,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -57310,7 +61981,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlement + /configuration
@@ -57338,17 +62009,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing entitlement
-

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

+
create or update an existing configuration
+

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

Tags: Network
-

create or update an existing entitlement

+

create or update an existing configuration

@@ -57357,13 +62028,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated

+

configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)

- /entitlement + /configuration
@@ -57382,42 +62053,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + configuration-id -

Unique ID of an entitlement resource.

+

UUID assigned to configuration.

 path @@ -57459,23 +62098,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing entitlement
-

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

+
update an existing configuration
+

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

Tags: Network
-

delete an existing entitlement

+

update an existing configuration

application/json application/xml

+
+
+

configuration object that needs to be created or updated.

+

+
+
+
+
+ /configuration +
+
+
@@ -57491,26 +62142,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- group-uuid + configuration-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

UUID assigned to configuration.

 path @@ -57521,38 +62156,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid - -

Unique ID of an entitlement resource.

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -57584,35 +62187,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

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

+
delete an existing configuration
+

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

Tags: Network
-

see node definition for valid relationships

+

delete an existing configuration

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -57628,26 +62219,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- group-uuid + configuration-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

UUID assigned to configuration.

 path @@ -57660,12 +62235,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + resource-version -

Unique ID of an entitlement resource.

+

resource-version for concurrency

pathquery string @@ -57705,24 +62280,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

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

+
returns metadata
+

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

Tags: Network
-

delete an existing relationship

+

returns metadata

-
- -

application/json application/xml -

-
@@ -57737,10 +62307,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -57792,6 +62360,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
default @@ -57814,17 +62405,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

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

+
returns metadatum
+

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

Tags: Network
-

returns l-interfaces

+

returns metadatum

@@ -57841,10 +62432,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - + + +
- vnf-id + configuration-id -

Unique id of VNF. This is unique across the graph.

+

UUID assigned to configuration.

 path @@ -57753,34 +62323,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + model-invariant-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

the ASDC model id for this resource or service model.

pathquery string -
- resource-uuid + model-version-id -

Unique ID of an entitlement resource.

+

the ASDC model version for this resource or service model.

pathquery string -
- vnf-id + configuration-id -

Unique id of VNF. This is unique across the graph.

+

UUID assigned to configuration.

 path @@ -57857,70 +62448,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + metaname -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

querypath string +
- regional-resource-zone + model-invariant-id -

Regional way of organizing pservers, source of truth should define values

+

the ASDC model id for this resource or service model.

 query @@ -57932,10 +62478,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + model-version-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

the ASDC model version for this resource or service model.

 query @@ -57945,130 +62491,335 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /metadatum +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing metadatum
+

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

+ Tags: + Network +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfigurationMetadataMetadatum.json)

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - + + +
- heat-stack-id + configuration-id -

Heat stack id corresponding to this instance, managed by MSO

+

UUID assigned to configuration.

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id + metaname -

the ASDC model id for this resource or service model.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

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

+ Tags: + Network +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /metadatum +
+
+
+
+
+ + + + + + + + + + + - + - + + +
- model-version-id + configuration-id -

the ASDC model version for this resource or service model.

+

UUID assigned to configuration.

querypath string +
- widget-model-id + metaname -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing metadatum
+

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

+ Tags: + Network +
+
+
+

delete an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + +
- widget-model-version + configuration-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

UUID assigned to configuration.

querypath string +
- nf-type + metaname -

Generic description of the type of NF

querypath string +
- nf-function + resource-version -

English description of Network function that the specific VNF deployment is providing

+

resource-version for concurrency

 query @@ -58076,42 +62827,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkConfigurationsConfiguration.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + + +
- nf-role + configuration-id -

role in the network that this model will be providing

+

UUID assigned to configuration.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - +
- nf-naming-code + configuration-id -

string assigned to this model used for naming purposes

+

UUID assigned to configuration.

querypath 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

@@ -58134,7 +63063,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /generic-vnfs
@@ -58162,17 +63091,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

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

+
returns generic-vnf
+

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

Tags: Network
-

returns l-interface

+

returns generic-vnf

@@ -58203,22 +63132,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
vnf-name @@ -58472,51 +63385,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -58543,7 +63411,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /generic-vnf
@@ -58571,17 +63439,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing l-interface
-

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

+
create or update an existing generic-vnf
+

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

Tags: Network
-

create or update an existing l-interface

+

create or update an existing generic-vnf

@@ -58590,13 +63458,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)

- /l-interface + /generic-vnf
@@ -58629,22 +63497,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
@@ -58676,23 +63528,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

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

+
update an existing generic-vnf
+

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

Tags: Network
-

delete an existing l-interface

+

update an existing generic-vnf

application/json application/xml

+
+
+

generic-vnf object that needs to be created or updated.

+

+
+
+
+
+ /generic-vnf +
+
+
@@ -58722,12 +63586,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name + vnf-id -

Name given to the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -58785,17 +63710,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns entitlements
+

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

Tags: Network
-

returns l3-interface-ipv4-address-list

+

returns entitlements

@@ -58826,38 +63751,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
vnf-name @@ -59111,96 +64004,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -59227,7 +64030,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /entitlements
@@ -59255,36 +64058,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns entitlement
+

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

Tags: Network
-

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

+

returns entitlement

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -59315,10 +64101,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - -
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -59331,469 +64117,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-uuid -

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

+

Unique ID of an entitlement resource.

 path @@ -60057,96 +64384,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -60173,7 +64410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /entitlement
@@ -60201,17 +64438,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

create or update an existing entitlement

@@ -60220,13 +64457,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

- /l3-interface-ipv6-address-list + /entitlement
@@ -60261,10 +64498,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -60277,10 +64514,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

 path @@ -60322,23 +64559,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing entitlement
+

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

Tags: Network
-

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

+

update an existing entitlement

application/json application/xml

+
+
+

entitlement object that needs to be created or updated.

+

+
+
+
+
+ /entitlement +
+
+
@@ -60370,10 +64619,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -60386,10 +64635,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-uuid -

IP address

+

Unique ID of an entitlement resource.

 path @@ -60400,22 +64649,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -60447,35 +64680,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing entitlement
+

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

Tags: Network
-

see node definition for valid relationships

+

delete an existing entitlement

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -60507,103 +64728,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- 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 + group-uuid -

Unique id of VNF. This is unique across the graph.

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -60616,10 +64744,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-uuid -

Name given to the interface

+

Unique ID of an entitlement resource.

 path @@ -60632,12 +64760,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -60677,11 +64805,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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

Tags: Network
@@ -60696,7 +64824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfEntitlementsEntitlement.json)

@@ -60737,10 +64865,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

 path @@ -60782,11 +64926,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: Network
@@ -60830,10 +64974,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + group-uuid -

Name given to the interface

+

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

 path @@ -60875,17 +65035,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

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

+
returns l-interfaces
+

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

Tags: Network
-

returns sriov-vfs

+

returns l-interfaces

@@ -60916,22 +65076,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
vnf-name @@ -61185,51 +65329,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -61256,7 +65355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l-interfaces
@@ -61284,17 +65383,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

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

+
returns l-interface
+

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

Tags: Network
-

returns sriov-vf

+

returns l-interface

@@ -61341,22 +65440,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
vnf-name @@ -61655,66 +65738,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -61741,7 +65764,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l-interface
@@ -61769,17 +65792,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

create or update an existing l-interface

@@ -61788,13 +65811,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

- /sriov-vf + /l-interface
@@ -61843,22 +65866,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -61890,23 +65897,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing l-interface
+

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

Tags: Network
-

delete an existing sriov-vf

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -61952,38 +65971,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -62015,35 +66002,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing l-interface
+

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

Tags: Network
-

see node definition for valid relationships

+

delete an existing l-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -62091,12 +66066,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

pathquery string @@ -62136,24 +66111,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -62200,98 +66170,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- 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 + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -62600,6 +66482,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -62626,7 +66553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l3-interface-ipv4-address-list
@@ -62654,19 +66581,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlan
-

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

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

returns vlan

+

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

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -62713,10 +66657,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -62727,325 +66671,242 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

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

English description of Network function that the specific VNF deployment is providing

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-role + interface-name -

role in the network that this model will be providing

+

Name given to the interface

querypath string +
- nf-naming-code + l3-interface-ipv4-address -

string assigned to this model used for naming purposes

+

IP address

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

+
+
+ + + + + + + + + + + - + - + - + - - - - - - - @@ -63064,29 +66926,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -63109,17 +66948,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

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

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

create or update an existing vlan

+

see node definition for valid relationships

@@ -63128,13 +66967,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /vlan + /relationship
@@ -63185,10 +67024,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key + resource-version -

This indicates the customers VPN ID associated with this vlan

+

resource-version for concurrency

 query @@ -63053,6 +66914,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -63230,17 +67069,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

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

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

+

delete an existing relationship

@@ -63294,10 +67133,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -63308,22 +67147,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -63355,17 +67178,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

returns l3-interface-ipv6-address-list

@@ -63414,23 +67237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -63757,36 +67564,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 @@ -63843,7 +67620,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -63871,17 +67648,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

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

@@ -63890,13 +67667,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -63947,23 +67724,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -64008,23 +67769,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

Tags: Network
-

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

+

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 +
+
+
@@ -64072,10 +67845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -64086,9 +67859,102 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

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

@@ -64149,11 +68015,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -64168,7 +68034,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -64225,23 +68091,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -64286,11 +68136,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -64350,10 +68200,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

 path @@ -64366,10 +68305,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-name -

IP address

+

Name given to the interface

 path @@ -64411,19 +68350,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
delete an existing relationship
+

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

Tags: Network
-

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -64468,12 +68412,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + vnf-id -

String that identifies the interface

+

Unique id of VNF. This is unique across the graph.

 path @@ -64486,10 +68486,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name given to the interface

 path @@ -64798,81 +68798,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -64899,7 +68824,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /sriov-vfs
@@ -64927,36 +68852,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

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

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -65003,10 +68911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -65042,6 +69292,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -65064,23 +69337,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

+

create or update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -65019,18 +68927,360 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vnf-name -

IP address

+

Name of VNF.

pathquery + 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 -
@@ -65128,26 +69413,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -65158,22 +69427,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -65205,17 +69458,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing sriov-vf
+

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

Tags: Network
-

see node definition for valid relationships

+

update an existing sriov-vf

@@ -65224,13 +69477,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

sriov-vf object that needs to be created or updated.

- /relationship + /sriov-vf
@@ -65281,26 +69534,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -65342,17 +69579,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

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

+

delete an existing sriov-vf

@@ -65406,10 +69643,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -65422,12 +69659,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -65467,11 +69704,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -65486,7 +69723,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -65543,10 +69780,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -65588,11 +69825,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -65652,10 +69889,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + pci-id -

String that identifies the interface

+

PCI ID used to identify the sriov-vf

 path @@ -65697,17 +69934,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

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

+
returns vlans
+

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

Tags: Network
-

returns lag-interfaces

+

returns vlans

@@ -65738,6 +69975,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
vnf-name @@ -65991,6 +70244,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
@@ -66017,7 +70315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /vlans
@@ -66045,17 +70343,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns lag-interface
-

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

+
returns vlan
+

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

Tags: Network
-

returns lag-interface

+

returns vlan

@@ -66091,7 +70389,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -66372,10 +70686,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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 @@ -66411,7 +70770,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /vlan
@@ -66439,17 +70798,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

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

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

+

create or update an existing vlan

@@ -66458,13 +70817,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

- /lag-interface + /vlan
@@ -66502,7 +70861,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -66544,23 +70919,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-interface
-

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

+
update an existing vlan
+

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

Tags: Network
-

delete an existing lag-interface

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -66595,7 +70982,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + +
-

Name that identifies the link aggregate interface

+

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 @@ -66653,17 +71165,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

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

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

+

returns l3-interface-ipv4-address-list

@@ -66699,7 +71211,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -66980,10 +71524,100 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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 @@ -67019,7 +71653,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /l3-interface-ipv4-address-list
@@ -67047,19 +71681,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

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

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

returns l-interface

+

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

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -67093,7 +71744,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -67106,10 +71757,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -67122,323 +71773,288 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + l3-interface-ipv4-address -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + + +
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

+

Name given to the interface

querypath string +
- nf-role + vlan-interface -

role in the network that this model will be providing

+

String that identifies the interface

querypath string +
- nf-naming-code + l3-interface-ipv4-address -

string assigned to this model used for naming purposes

+

IP address

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

+
+
+ + + + + + + + + + + - + - + - + - + @@ -67457,29 +72074,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -67502,17 +72096,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

create or update an existing l-interface

+

see node definition for valid relationships

@@ -67521,13 +72115,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /l-interface + /relationship
@@ -67565,7 +72159,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name given to the interface

querypath string +
- interface-id + vlan-interface -

ID of interface

+

String that identifies the interface

querypath string +
- macaddr + l3-interface-ipv4-address -

MAC address for the interface

+

IP address

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

 query @@ -67446,6 +72062,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -67578,10 +72172,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -67623,17 +72233,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

delete an existing relationship

@@ -67674,7 +72284,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -67687,10 +72297,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -67703,12 +72313,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -67748,17 +72358,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

returns l3-interface-ipv6-address-list

@@ -67794,7 +72404,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -67807,10 +72417,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -67823,7 +72433,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -68107,10 +72717,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + macaddr -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

MAC address for the interface

 query @@ -68122,10 +72732,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-name -

ID of interface

+

Name of the network

 query @@ -68137,14 +72747,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

+

Inner VLAN tag

 query - string + integer @@ -68152,10 +72762,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vpn-key -

Name of the network

+

This indicates the customers VPN ID associated with this vlan

 query @@ -68236,7 +72846,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -68264,17 +72874,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

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

@@ -68283,13 +72893,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -68327,7 +72937,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -68340,10 +72950,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -68356,7 +72966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -68401,23 +73011,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

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

Tags: Network
-

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

+

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 +
+
+
@@ -68452,7 +73074,116 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + + + + + + + + + + + + + + + + + + + +
-

Name that identifies the link aggregate interface

+

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 @@ -68481,7 +73212,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address

IP address

@@ -68542,11 +73289,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -68561,7 +73308,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -68605,7 +73352,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -68618,10 +73365,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -68634,7 +73381,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -68679,11 +73426,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -68730,7 +73477,128 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + - - - - - - -
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

 path @@ -68759,10 +73627,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -68804,19 +73672,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -68850,7 +73723,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
-

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -68863,10 +73736,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -68877,12 +73750,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + +
- l3-interface-ipv6-address + vnf-id -

IP address

+

Unique id of VNF. This is unique across the graph.

 path @@ -69146,42 +74075,123 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - -
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-role + interface-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name that identifies the link aggregate interface

querypath string +
- interface-id + vnf-name -

ID of interface

+

Name of VNF.

 query @@ -69193,10 +74203,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vnf-name2 -

MAC address for the interface

+

Alternate name of VNF.

 query @@ -69208,10 +74218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vnf-type -

Name of the network

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -69223,14 +74233,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + service-id -

Inner VLAN tag

+

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

 query - integer + string @@ -69238,10 +74248,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + regional-resource-zone -

Neutron network id of the interface that address belongs to

+

Regional way of organizing pservers, source of truth should define values

 query @@ -69253,10 +74263,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + prov-status -

Neutron id of subnet that address belongs to

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -69266,297 +74276,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + heat-stack-id -

Unique id of VNF. This is unique across the graph.

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- interface-name + in-maint -

Name that identifies the link aggregate interface

pathquery - string + boolean -
- interface-name + is-closed-loop-disabled -

Name given to the interface

pathquery - string + boolean -
- l3-interface-ipv6-address + model-invariant-id -

IP address

+

the ASDC model id for this resource or service model.

pathquery 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 + model-version-id -

Unique id of VNF. This is unique across the graph.

+

the ASDC model version for this resource or service model.

pathquery string -
- interface-name + widget-model-id -

Name that identifies the link aggregate interface

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

pathquery string -
- interface-name + widget-model-version -

Name given to the interface

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

pathquery string -
- l3-interface-ipv6-address + nf-type -

IP address

+

Generic description of the type of NF

pathquery string -
- resource-version + nf-function -

resource-version for concurrency

+

English description of Network function that the specific VNF deployment is providing

 query @@ -69564,144 +74407,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

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 -
-
-
-
-
- - - - - - - - - - - - + - + - + - + @@ -69713,6 +74478,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
default @@ -69735,23 +74523,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
create or update an existing lag-interface
+

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

Tags: Network
-

delete an existing relationship

+

create or update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /lag-interface +
+
+
- vnf-id + nf-role -

Unique id of VNF. This is unique across the graph.

+

role in the network that this model will be providing

pathquery string -
- interface-name + nf-naming-code -

Name that identifies the link aggregate interface

+

string assigned to this model used for naming purposes

pathquery string -
- interface-name + interface-id -

Name given to the interface

+

ID of interface

pathquery string -
- l3-interface-ipv6-address + interface-role -

IP address

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

pathquery string -
@@ -69797,38 +74597,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
@@ -69860,17 +74628,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing lag-interface
+

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

Tags: Network
-

see node definition for valid relationships

+

update an existing lag-interface

@@ -69879,13 +74647,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

lag-interface object that needs to be created or updated.

- /relationship + /lag-interface
@@ -69934,22 +74702,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
@@ -69981,17 +74733,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing lag-interface
+

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

Tags: Network
-

delete an existing relationship

+

delete an existing lag-interface

@@ -70045,12 +74797,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + resource-version -

Name given to the interface

+

resource-version for concurrency

pathquery string @@ -70090,17 +74842,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns l-interfaces
+

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

Tags: Network
-

returns sriov-vfs

+

returns l-interfaces

@@ -70147,22 +74899,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
vnf-name @@ -70446,51 +75182,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name - -

Name of the network

- 		query - string - - -
@@ -70517,7 +75208,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l-interfaces
@@ -70545,17 +75236,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

returns l-interface

@@ -70618,22 +75309,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
vnf-name @@ -70962,66 +75637,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -71048,7 +75663,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l-interface
@@ -71076,17 +75691,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

create or update an existing l-interface

@@ -71095,13 +75710,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /sriov-vf + /l-interface
@@ -71166,22 +75781,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

- 		path - string - - - -
@@ -71213,23 +75812,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing l-interface
+

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

Tags: Network
-

delete an existing sriov-vf

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -71291,12 +75902,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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 + + + +
- pci-id + interface-name -

PCI ID used to identify the sriov-vf

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -71354,161 +76058,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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

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

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -71571,114 +76133,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- 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 + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -72017,6 +76475,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -72043,7 +76546,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l3-interface-ipv4-address-list
@@ -72071,19 +76574,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

returns vlan

+

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

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -72146,10 +76666,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -72160,355 +76680,274 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

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

English description of Network function that the specific VNF deployment is providing

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-role + interface-name -

role in the network that this model will be providing

+

Name that identifies the link aggregate interface

querypath string +
- nf-naming-code + interface-name -

string assigned to this model used for naming purposes

+

Name given to the interface

querypath string +
- interface-id + l3-interface-ipv4-address -

ID of interface

+

IP address

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

+
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - @@ -72527,29 +76967,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -72572,17 +76989,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

create or update an existing vlan

+

see node definition for valid relationships

@@ -72591,13 +77008,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

- /vlan + /relationship
@@ -72664,10 +77081,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- interface-role + vnf-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the link aggregate interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key + resource-version -

This indicates the customers VPN ID associated with this vlan

+

resource-version for concurrency

 query @@ -72516,6 +76955,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -72709,17 +77126,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

delete an existing relationship

@@ -72789,10 +77206,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

 path @@ -72803,22 +77220,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -72850,17 +77251,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

returns l3-interface-ipv6-address-list

@@ -72925,23 +77326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -73300,10 +77685,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + neutron-network-id -

This indicates the customers VPN ID associated with this vlan

+

Neutron network id of the interface that address belongs to

 query @@ -73315,47 +77700,11324 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + neutron-subnet-id -

Inner VLAN tag

+

Neutron id of subnet that address belongs to

 query - integer + 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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

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

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

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

+ Tags: + Network +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-vf
+

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

+ Tags: + Network +
+
+
+

delete an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vlan
+

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

+ Tags: + Network +
+
+
+

update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

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

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

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

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
+ vnf-name + +

Name of VNF.

+ 		query + string + + +
+ vnf-name2 + +

Alternate name of VNF.

+ 		query + string + + +
+ vnf-type + +

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+ 		query + string + + +
+ service-id + +

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+ 		query + string + + +
+ regional-resource-zone + +

Regional way of organizing pservers, source of truth should define values

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+ 		query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+ 		query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+ 		query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+ 		query + string + + +
+ nf-type + +

Generic description of the type of NF

+ 		query + string + + +
+ nf-function + +

English description of Network function that the specific VNF deployment is providing

+ 		query + string + + +
+ nf-role + +

role in the network that this model will be providing

+ 		query + string + + +
+ nf-naming-code + +

string assigned to this model used for naming purposes

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

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

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

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

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing license
+

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

+ Tags: + Network +
+
+
+

update an existing license

+ +
+
+ +

application/json application/xml +

+
+
+

license object that needs to be created or updated.

+

+
+
+
+
+ /license +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing license
+

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

+ Tags: + Network +
+
+
+

delete an existing license

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ group-uuid + +

Unique ID for the license group the resource belongs to, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of a license resource.

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfLicensesLicense.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnf.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

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

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vf-module
+

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

+ Tags: + Network +
+
+
+

update an existing vf-module

+ +
+
+ +

application/json application/xml +

+
+
+

vf-module object that needs to be created or updated.

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)

+

+
+
+
+
+ /instance-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing instance-group
+

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

+ Tags: + Network +
+
+
+

update an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+

instance-group object that needs to be created or updated.

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkInstanceGroupsInstanceGroup.json)

+

+
+
+
+
+ /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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

+
+
+
+
+ /ipsec-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing ipsec-configuration
+

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

+ Tags: + Network +
+
+
+

update an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+

ipsec-configuration object that needs to be created or updated.

+

+
+
+
+
+ /ipsec-configuration +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing ipsec-configuration
+

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

+ Tags: + Network +
+
+
+

delete an existing ipsec-configuration

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfiguration.json)

+

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

+ +
+
+ + + + + + + + + + + - + - + @@ -73384,7 +89046,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vig-server
@@ -73412,17 +89074,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

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

+

create or update an existing vig-server

@@ -73431,13 +89093,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

vig-server object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

- /l3-interface-ipv4-address-list + /vig-server
@@ -73456,58 +89118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- neutron-network-id + ipsec-configuration-id -

Neutron network id of the interface that address belongs to

+

UUID of this configuration

querypath string +
- neutron-subnet-id + vig-address-type -

Neutron id of subnet that address belongs to

+

indicates whether the VIG is for AVPN or INTERNET

querypath string +
- 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 + ipsec-configuration-id -

String that identifies the interface

+

UUID of this configuration

 path @@ -73520,10 +89134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -73565,23 +89179,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing vig-server
+

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

Tags: Network
-

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

+

update an existing vig-server

application/json application/xml

+
+
+

vig-server object that needs to be created or updated.

+

+
+
+
+
+ /vig-server +
+
+
@@ -73597,26 +89223,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + ipsec-configuration-id -

Name that identifies the link aggregate interface

+

UUID of this configuration

 path @@ -73629,10 +89239,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vig-address-type -

Name given to the interface

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -73643,12 +89253,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- vlan-interface + ipsec-configuration-id -

String that identifies the interface

+

UUID of this configuration

 path @@ -73661,10 +89332,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -73722,11 +89393,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: Network
@@ -73741,7 +89412,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkIpsecConfigurationsIpsecConfigurationVigServersVigServer.json)

@@ -73766,58 +89437,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + ipsec-configuration-id -

String that identifies the interface

+

UUID of this configuration

 path @@ -73830,10 +89453,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -73875,11 +89498,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: Network
@@ -73907,58 +89530,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + ipsec-configuration-id -

String that identifies the interface

+

UUID of this configuration

 path @@ -73971,10 +89546,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vig-address-type -

IP address

+

indicates whether the VIG is for AVPN or INTERNET

 path @@ -74016,17 +89591,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns l3-networks
+

GET /network/l3-networks

Tags: Network
-

returns l3-interface-ipv6-address-list

+

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

@@ -74043,74 +89682,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + network-id -

IP address

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -74123,25 +89698,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 + network-name -

Alternate name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -74153,10 +89713,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + network-role -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Role the network plans - who defines these values?

 query @@ -74171,37 +89731,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -74228,27 +89758,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + contrail-network-fqdn +

Contrail FQDN for the network

 query - boolean + string @@ -74314,57 +89831,290 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)

+

+
+
+
+
+ /l3-network +
+
+
+
+
+ + + + + + + + + + + - + + +
- nf-type + network-id -

Generic description of the type of NF

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-network
+

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

+ Tags: + Network +
+
+
+

update an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+

l3-network object that needs to be created or updated.

+

+
+
+
+
+ /l3-network +
+
+
+
+
+ + + + + + + + + + + - + + +
- nf-function + network-id -

English description of Network function that the specific VNF deployment is providing

+

Network ID, should be uuid. Unique across A&AI.

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

+
+
+ + + + + + + + + + + - + + +
- nf-role + network-id -

role in the network that this model will be providing

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- nf-naming-code + resource-version -

string assigned to this model used for naming purposes

+

resource-version for concurrency

 query @@ -74372,29 +90122,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + + + + + + + + + + + + + + +
- interface-id + network-id -

ID of interface

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- interface-role + network-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name of the network, governed by some naming convention..

 query @@ -74406,10 +90214,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-role -

ID of interface

+

Role the network plans - who defines these values?

 query @@ -74421,10 +90229,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + service-id -

MAC address for the interface

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -74436,10 +90244,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + heat-stack-id -

Name of the network

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -74451,14 +90259,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + contrail-network-fqdn -

Inner VLAN tag

+

Contrail FQDN for the network

 query - integer + string @@ -74466,10 +90274,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + model-invariant-id -

This indicates the customers VPN ID associated with this vlan

+

the ASDC model id for this resource or service model.

 query @@ -74481,14 +90289,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + model-version-id -

Inner VLAN tag

+

the ASDC model version for this resource or service model.

 query - integer + string @@ -74496,10 +90304,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + widget-model-id -

Neutron network id of the interface that address belongs to

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query @@ -74511,10 +90319,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + widget-model-version -

Neutron id of subnet that address belongs to

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -74550,7 +90358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /ctag-assignments
@@ -74578,36 +90386,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns ctag-assignment
+

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

Tags: Network
-

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

+

returns ctag-assignment

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -74622,10 +90413,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - -
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -74638,14 +90429,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-id-inner -

Name that identifies the link aggregate interface

+

id.

 path - string + integer @@ -74654,199 +90445,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + network-name -

Name given to the interface

+

Name of the network, governed by some naming convention..

pathquery string -
- vlan-interface + network-role -

String that identifies the interface

+

Role the network plans - who defines these values?

pathquery string -
- l3-interface-ipv6-address + service-id -

IP address

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

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

-
-
- - - - - - - - - - - - + - + - + - + - + @@ -74866,6 +90587,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-assignment +
+
+
+ +
default @@ -74888,17 +90632,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
create or update an existing ctag-assignment
+

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

Tags: Network
-

see node definition for valid relationships

+

create or update an existing ctag-assignment

@@ -74907,13 +90651,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

ctag-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

- /relationship + /ctag-assignment
@@ -74932,58 +90676,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vnf-id + heat-stack-id -

Unique id of VNF. This is unique across the graph.

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- interface-name + contrail-network-fqdn -

Name that identifies the link aggregate interface

+

Contrail FQDN for the network

pathquery string -
- interface-name + model-invariant-id -

Name given to the interface

+

the ASDC model id for this resource or service model.

pathquery string -
- vlan-interface + model-version-id -

String that identifies the interface

+

the ASDC model version for this resource or service model.

pathquery string -
- l3-interface-ipv6-address + widget-model-id -

IP address

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

pathquery string -
- resource-version + widget-model-version -

resource-version for concurrency

+

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query @@ -74854,7 +90576,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- 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 + network-id -

String that identifies the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -74996,14 +90692,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-id-inner -

IP address

+

id.

 path - string + integer @@ -75041,23 +90737,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
update an existing ctag-assignment
+

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

Tags: Network
-

delete an existing relationship

+

update an existing ctag-assignment

application/json application/xml

+
+
+

ctag-assignment object that needs to be created or updated.

+

+
+
+
+
+ /ctag-assignment +
+
+
@@ -75073,10 +90781,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75089,26 +90797,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-id-inner -

Name that identifies the link aggregate interface

+

id.

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

+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + +
- interface-name + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75121,14 +90890,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vlan-id-inner -

String that identifies the interface

+

id.

 path - string + integer @@ -75137,12 +90906,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -75182,11 +90951,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: Network
@@ -75201,7 +90970,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkCtagAssignmentsCtagAssignment.json)

@@ -75226,42 +90995,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75274,14 +91011,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vlan-id-inner -

String that identifies the interface

+

id.

 path - string + integer @@ -75319,11 +91056,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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

Tags: Network
@@ -75351,42 +91088,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + network-id -

Name given to the interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75399,14 +91104,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vlan-id-inner -

String that identifies the interface

+

id.

 path - string + integer @@ -75444,11 +91149,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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

Tags: Network
@@ -75463,7 +91168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3Network.json)

@@ -75488,26 +91193,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + network-id -

Name that identifies the link aggregate interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75549,11 +91238,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: Network
@@ -75581,26 +91270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- interface-name + network-id -

Name that identifies the link aggregate interface

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75642,17 +91315,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns licenses
-

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

+
returns segmentation-assignments
+

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

Tags: Network
-

returns licenses

+

returns segmentation-assignments

@@ -75669,10 +91342,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -75685,10 +91358,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + network-name -

Name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -75700,10 +91373,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + network-role -

Alternate name of VNF.

+

Role the network plans - who defines these values?

 query @@ -75715,10 +91388,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + service-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -75730,10 +91403,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + heat-stack-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -75745,10 +91418,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + contrail-network-fqdn -

Regional way of organizing pservers, source of truth should define values

+

Contrail FQDN for the network

 query @@ -75760,10 +91433,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + model-invariant-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

the ASDC model id for this resource or service model.

 query @@ -75775,10 +91448,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + model-version-id -

Heat stack id corresponding to this instance, managed by MSO

+

the ASDC model version for this resource or service model.

 query @@ -75790,13 +91463,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + widget-model-id +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

 query - boolean + string @@ -75804,24 +91478,136 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + widget-model-version +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

 query - boolean + 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 +
- model-invariant-id + segmentation-id -

the ASDC model id for this resource or service model.

+

Route Table Reference id, UUID assigned to this instance.

+ 		path + string + + + +
+ network-name + +

Name of the network, governed by some naming convention..

 query @@ -75833,10 +91619,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + network-role -

the ASDC model version for this resource or service model.

+

Role the network plans - who defines these values?

 query @@ -75848,10 +91634,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + service-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -75863,10 +91649,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + heat-stack-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -75878,10 +91664,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + contrail-network-fqdn -

Generic description of the type of NF

+

Contrail FQDN for the network

 query @@ -75893,10 +91679,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + model-invariant-id -

English description of Network function that the specific VNF deployment is providing

+

the ASDC model id for this resource or service model.

 query @@ -75908,10 +91694,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + model-version-id -

role in the network that this model will be providing

+

the ASDC model version for this resource or service model.

 query @@ -75923,10 +91709,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + widget-model-id -

string assigned to this model used for naming purposes

+

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 @@ -75962,7 +91763,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /licenses + /segmentation-assignment
@@ -75990,19 +91791,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns license
-

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

+
create or update an existing segmentation-assignment
+

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

Tags: Network
-

returns license

+

create or update an existing segmentation-assignment

+
+ +

application/json application/xml +

+
+
+

segmentation-assignment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

+
+
+
+
+ /segmentation-assignment +
+
+
+
@@ -76017,10 +91835,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -76033,10 +91851,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + segmentation-id -

Unique ID for the license group the resource belongs to, should be uuid.

+

Route Table Reference id, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing segmentation-assignment
+

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

+ Tags: + Network +
+
+
+

update an existing segmentation-assignment

+ +
+
+ +

application/json application/xml +

+
+
+

segmentation-assignment object that needs to be created or updated.

+

+
+
+
+
+ /segmentation-assignment +
+
+
+
+
+ + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

 path @@ -76049,10 +91956,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + segmentation-id -

Unique ID of a license resource.

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -76063,27 +91970,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - + + + + + + + + + + +
- vnf-name + network-id -

Name of VNF.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- vnf-name2 + segmentation-id -

Alternate name of VNF.

+

Route Table Reference id, UUID assigned to this instance.

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

 query @@ -76091,29 +92076,285 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSegmentationAssignmentsSegmentationAssignment.json)

+

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

+ +
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-type + network-id -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- service-id + network-name -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

+

Name of the network, governed by some naming convention..

 query @@ -76125,10 +92366,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + network-role -

Regional way of organizing pservers, source of truth should define values

+

Role the network plans - who defines these values?

 query @@ -76140,10 +92381,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + service-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -76170,27 +92411,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + contrail-network-fqdn +

Contrail FQDN for the network

 query - boolean + string @@ -76256,66 +92484,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -76342,7 +92510,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /license + /subnets
@@ -76370,36 +92538,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing license
-

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

+
returns subnet
+

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

Tags: Network
-

create or update an existing license

+

returns subnet

-
- -

application/json application/xml -

-
-
-

license object that needs to be created or updated

-

-
-
-
-
- /license -
-
-
-
@@ -76414,10 +92565,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -76430,10 +92581,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + subnet-id -

Unique ID for the license group the resource belongs to, should be uuid.

+

Subnet ID, should be UUID.

 path @@ -76446,135 +92597,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + network-name -

Unique ID of a license resource.

+

Name of the network, governed by some naming convention..

pathquery 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 + network-role -

Unique id of VNF. This is unique across the graph.

+

Role the network plans - who defines these values?

pathquery string -
- group-uuid + service-id -

Unique ID for the license group the resource belongs to, should be uuid.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

pathquery string -
- resource-uuid + heat-stack-id -

Unique ID of a license resource.

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- resource-version + contrail-network-fqdn -

resource-version for concurrency

+

Contrail FQDN for the network

 query @@ -76582,128 +92668,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

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 -
-
-
-
-
- - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + @@ -76715,6 +92754,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /subnet +
+
+
+ +
default @@ -76737,23 +92799,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

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

+
create or update an existing subnet
+

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

Tags: Network
-

delete an existing relationship

+

create or update an existing subnet

application/json application/xml

+
+
+

subnet object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

+

+
+
+
+
+ /subnet +
+
+
- vnf-id + model-invariant-id -

Unique id of VNF. This is unique across the graph.

+

the ASDC model id for this resource or service model.

pathquery string -
- group-uuid + model-version-id -

Unique ID for the license group the resource belongs to, should be uuid.

+

the ASDC model version for this resource or service model.

pathquery string -
- resource-uuid + widget-model-id -

Unique ID of a license resource.

+

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

pathquery + 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 -
@@ -76769,26 +92843,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- vnf-id - -

Unique id of VNF. This is unique across the graph.

- 		path - string - - - -
- group-uuid + network-id -

Unique ID for the license group the resource belongs to, should be uuid.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -76801,10 +92859,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + subnet-id -

Unique ID of a license resource.

+

Subnet ID, should be UUID.

 path @@ -76846,17 +92904,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

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

+
update an existing subnet
+

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

Tags: Network
-

see node definition for valid relationships

+

update an existing subnet

@@ -76865,13 +92923,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

subnet object that needs to be created or updated.

- /relationship + /subnet
@@ -76890,10 +92948,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

 path @@ -76935,17 +93009,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

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

+
delete an existing subnet
+

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

Tags: Network
-

delete an existing relationship

+

delete an existing subnet

@@ -76967,10 +93041,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ subnet-id + +

Subnet ID, should be UUID.

 path @@ -76981,6 +93071,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -77012,17 +93118,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vf-modules
-

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

+
returns host-routes
+

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

Tags: Network
-

returns vf-modules

+

returns host-routes

@@ -77039,10 +93145,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -77055,25 +93161,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + subnet-id -

Name of VNF.

+

Subnet ID, should be UUID.

querypath string +
- vnf-name2 + network-name -

Alternate name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -77085,10 +93192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + network-role -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Role the network plans - who defines these values?

 query @@ -77103,37 +93210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -77160,27 +93237,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + contrail-network-fqdn +

Contrail FQDN for the network

 query - boolean + string @@ -77248,55 +93312,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + subnet-name -

string assigned to this model used for naming purposes

+

Name associated with the subnet.

 query @@ -77332,7 +93351,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vf-modules + /host-routes
@@ -77360,17 +93379,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vf-module
-

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

+
returns host-route
+

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

Tags: Network
-

returns vf-module

+

returns host-route

@@ -77387,10 +93406,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -77403,10 +93422,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + subnet-id -

Unique ID of vf-module.

+

Subnet ID, should be UUID.

 path @@ -77419,25 +93438,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + host-route-id -

Name of VNF.

+

host-route id

querypath string +
- vnf-name2 + network-name -

Alternate name of VNF.

+

Name of the network, governed by some naming convention..

 query @@ -77449,10 +93469,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + network-role -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Role the network plans - who defines these values?

 query @@ -77467,37 +93487,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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.

+

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

 query @@ -77524,27 +93514,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + contrail-network-fqdn +

Contrail FQDN for the network

 query - boolean + string @@ -77612,10 +93589,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + subnet-name -

Generic description of the type of NF

+

Name associated with the subnet.

 query @@ -77625,147 +93602,386 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /host-route +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing host-route
+

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

+ Tags: + Network +
+
+
+

create or update an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

+
+
+
+
+ /host-route +
+
+
+
+
+ + + + + + + + + + + - + - + - + + +
- nf-function + network-id -

English description of Network function that the specific VNF deployment is providing

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- nf-role + subnet-id -

role in the network that this model will be providing

+

Subnet ID, should be UUID.

querypath string +
- nf-naming-code + host-route-id -

string assigned to this model used for naming purposes

+

host-route id

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing host-route
+

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

+ Tags: + Network +
+
+
+

update an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be created or updated.

+

+
+
+
+
+ /host-route +
+
+
+
+
+ + + + + + + + + + + - + - + - + + +
- vf-module-name + network-id -

Name of vf-module

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- heat-stack-id + subnet-id -

Heat stack id corresponding to this instance.

+

Subnet ID, should be UUID.

querypath string +
- model-invariant-id + host-route-id -

the ASDC model id for this resource or service model.

+

host-route id

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing host-route
+

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

+ Tags: + Network +
+
+
+

delete an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + @@ -77784,29 +94001,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vf-module -
-
-
- -
default @@ -77829,17 +94023,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vf-module
-

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

+
see node definition for valid relationships
+

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

Tags: Network
-

create or update an existing vf-module

+

see node definition for valid relationships

@@ -77848,13 +94042,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vf-module object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

- /vf-module + /relationship
@@ -77873,10 +94067,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + - - - - - - - - - - - - - - - - - - - - -
- model-version-id + network-id -

the ASDC model version for this resource or service model.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- widget-model-id + subnet-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Subnet ID, should be UUID.

querypath string +
- widget-model-version + host-route-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

host-route id

querypath string +
- contrail-service-instance-fqdn + resource-version -

the Contrail unique ID for a service-instance

+

resource-version for concurrency

 query @@ -77773,6 +93989,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -77889,10 +94083,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + subnet-id -

Unique ID of vf-module.

+

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

 path @@ -77934,17 +94144,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vf-module
-

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

+
delete an existing relationship
+

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

Tags: Network
-

delete an existing vf-module

+

delete an existing relationship

@@ -77966,10 +94176,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -77982,10 +94192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + subnet-id -

Unique ID of vf-module.

+

Subnet ID, should be UUID.

 path @@ -77998,12 +94208,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + host-route-id -

resource-version for concurrency

+

host-route id

querypath string @@ -78043,11 +94253,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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

Tags: Network
@@ -78062,7 +94272,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

@@ -78087,10 +94297,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -78103,10 +94313,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + subnet-id -

Unique ID of vf-module.

+

Subnet ID, should be UUID.

 path @@ -78148,11 +94358,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: Network
@@ -78180,10 +94390,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + network-id -

Unique id of VNF. This is unique across the graph.

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -78196,10 +94406,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-module-id + subnet-id -

Unique ID of vf-module.

+

Subnet ID, should be UUID.

 path @@ -78241,17 +94451,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns instance-groups
-

GET /network/instance-groups

+
returns lag-links
+

GET /network/lag-links

Tags: Network
-

returns instance-groups

+

returns lag-links

@@ -78277,7 +94487,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /instance-groups + /lag-links
@@ -78305,17 +94515,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns instance-group
-

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

+
returns lag-link
+

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

Tags: Network
-

returns instance-group

+

returns lag-link

@@ -78332,10 +94542,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + link-name -

Instance Group ID, UUID assigned to this instance.

+

Alphabetical concatenation of lag-interface names

 path @@ -78346,51 +94556,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -78417,7 +94582,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /instance-group + /lag-link
@@ -78445,17 +94610,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing instance-group
-

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

+
create or update an existing lag-link
+

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

Tags: Network
-

create or update an existing instance-group

+

create or update an existing lag-link

@@ -78464,13 +94629,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

instance-group object that needs to be created or updated

+

lag-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)

- /instance-group + /lag-link
@@ -78489,10 +94654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + link-name -

Instance Group ID, UUID assigned to this instance.

+

Alphabetical concatenation of lag-interface names

 path @@ -78534,23 +94699,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing instance-group
-

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

+
update an existing lag-link
+

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

Tags: Network
-

delete an existing instance-group

+

update an existing lag-link

application/json application/xml

+
+
+

lag-link object that needs to be created or updated.

+

+
+
+
+
+ /lag-link +
+
+
@@ -78566,10 +94743,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- id + link-name -

Instance Group ID, UUID assigned to this instance.

+

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 @@ -78627,11 +94881,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

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

Tags: Network
@@ -78646,7 +94900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLagLinksLagLink.json)

@@ -78671,10 +94925,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + link-name -

Instance Group ID, UUID assigned to this instance.

+

Alphabetical concatenation of lag-interface names

 path @@ -78716,11 +94970,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: Network
@@ -78748,10 +95002,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + link-name -

Instance Group ID, UUID assigned to this instance.

+

Alphabetical concatenation of lag-interface names

 path @@ -78793,17 +95047,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ipsec-configurations
-

GET /network/ipsec-configurations

+
returns logical-links
+

GET /network/logical-links

Tags: Network
-

returns ipsec-configurations

+

returns logical-links

@@ -78829,7 +95083,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ipsec-configurations + /logical-links
@@ -78857,17 +95111,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns ipsec-configuration
-

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

+
returns logical-link
+

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

Tags: Network
-

returns ipsec-configuration

+

returns logical-link

@@ -78884,10 +95138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + link-name -

UUID of this configuration

+

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

 path @@ -78898,6 +95152,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -78924,7 +95298,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ipsec-configuration + /logical-link
@@ -78952,17 +95326,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing ipsec-configuration
-

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

+
create or update an existing logical-link
+

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

Tags: Network
-

create or update an existing ipsec-configuration

+

create or update an existing logical-link

@@ -78971,13 +95345,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

ipsec-configuration object that needs to be created or updated

+

logical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)

- /ipsec-configuration + /logical-link
@@ -78996,10 +95370,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + link-name -

UUID of this configuration

+

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

 path @@ -79041,23 +95415,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing ipsec-configuration
-

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

+
update an existing logical-link
+

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

Tags: Network
-

delete an existing ipsec-configuration

+

update an existing logical-link

application/json application/xml

+
+
+

logical-link object that needs to be created or updated.

+

+
+
+
+
+ /logical-link +
+
+
@@ -79073,10 +95459,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- ipsec-configuration-id + link-name -

UUID of this configuration

+

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 @@ -79134,11 +95597,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

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

+

PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -79153,7 +95616,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkLogicalLinksLogicalLink.json)

@@ -79178,10 +95641,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + link-name -

UUID of this configuration

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path @@ -79223,11 +95686,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

+

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -79255,10 +95718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + link-name -

UUID of this configuration

+

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

 path @@ -79300,50 +95763,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vig-servers
-

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

+
returns multicast-configurations
+

GET /network/multicast-configurations

Tags: Network
-

returns vig-servers

+

returns multicast-configurations

-
- - - - - - - - - - - - - - - - - - - -
- ipsec-configuration-id - -

UUID of this configuration

- 		path - string - - - -
-

application/json application/xml @@ -79367,7 +95799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /vig-servers + /multicast-configurations
@@ -79395,17 +95827,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vig-server
-

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
returns multicast-configuration
+

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

returns vig-server

+

returns multicast-configuration

@@ -79422,26 +95854,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

- 		path - string - - - -
- vig-address-type + multicast-configuration-id -

indicates whether the VIG is for AVPN or INTERNET

+

Unique id of multicast configuration.

 path @@ -79478,7 +95894,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vig-server + /multicast-configuration
@@ -79506,17 +95922,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vig-server
-

PUT /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
create or update an existing multicast-configuration
+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

create or update an existing vig-server

+

create or update an existing multicast-configuration

@@ -79525,13 +95941,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vig-server object that needs to be created or updated

+

multicast-configuration object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)

- /vig-server + /multicast-configuration
@@ -79550,26 +95966,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

- 		path - string - - - -
- vig-address-type + multicast-configuration-id -

indicates whether the VIG is for AVPN or INTERNET

+

Unique id of multicast configuration.

 path @@ -79611,23 +96011,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vig-server
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}

+
update an existing multicast-configuration
+

PATCH /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

Tags: Network
-

delete an existing vig-server

+

update an existing multicast-configuration

application/json application/xml

+
+
+

multicast-configuration object that needs to be created or updated.

+

+
+
+
+
+ /multicast-configuration +
+
+
@@ -79643,10 +96055,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- ipsec-configuration-id + multicast-configuration-id -

UUID of this configuration

+

Unique id of multicast configuration.

 path @@ -79657,12 +96069,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
- vig-address-type + multicast-configuration-id -

indicates whether the VIG is for AVPN or INTERNET

+

Unique id of multicast configuration.

 path @@ -79720,11 +96193,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network
@@ -79739,7 +96212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkMulticastConfigurationsMulticastConfiguration.json)

@@ -79764,26 +96237,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

- 		path - string - - - -
- vig-address-type + multicast-configuration-id -

indicates whether the VIG is for AVPN or INTERNET

+

Unique id of multicast configuration.

 path @@ -79825,11 +96282,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

+

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

Tags: Network
@@ -79857,26 +96314,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id - -

UUID of this configuration

- 		path - string - - - -
- vig-address-type + multicast-configuration-id -

indicates whether the VIG is for AVPN or INTERNET

+

Unique id of multicast configuration.

 path @@ -79918,17 +96359,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-networks
-

GET /network/l3-networks

+
returns network-policies
+

GET /network/network-policies

Tags: Network
-

returns l3-networks

+

returns network-policies

@@ -79954,7 +96395,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-networks + /network-policies
@@ -79982,17 +96423,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-network
-

GET /network/l3-networks/l3-network/{network-id}

+
returns network-policy
+

GET /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

returns l3-network

+

returns network-policy

@@ -80009,10 +96450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + network-policy-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID representing unique key to this instance

 path @@ -80025,130 +96466,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + network-policy-fqdn -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Contrail FQDN for the policy

 query @@ -80184,7 +96505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-network + /network-policy
@@ -80212,17 +96533,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l3-network
-

PUT /network/l3-networks/l3-network/{network-id}

+
create or update an existing network-policy
+

PUT /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

create or update an existing l3-network

+

create or update an existing network-policy

@@ -80231,13 +96552,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-network object that needs to be created or updated

+

network-policy object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)

- /l3-network + /network-policy
@@ -80256,10 +96577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + network-policy-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID representing unique key to this instance

 path @@ -80301,23 +96622,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-network
-

DELETE /network/l3-networks/l3-network/{network-id}

+
update an existing network-policy
+

PATCH /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

delete an existing l3-network

+

update an existing network-policy

application/json application/xml

+
+
+

network-policy object that needs to be created or updated.

+

+
+
+
+
+ /network-policy +
+
+
@@ -80333,10 +96666,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-id + network-policy-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID representing unique key to this instance

 path @@ -80347,22 +96680,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -80394,19 +96711,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns ctag-assignments
-

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

+
delete an existing network-policy
+

DELETE /network/network-policies/network-policy/{network-policy-id}

Tags: Network
-

returns ctag-assignments

+

delete an existing network-policy

+
+ +

application/json application/xml +

+
@@ -80421,10 +96743,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -80579,29 +96782,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-assignments -
-
-
- -
default @@ -80624,19 +96804,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-assignment
-

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
see node definition for valid relationships
+

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network
-

returns ctag-assignment

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNetworkPoliciesNetworkPolicy.json)

+

+
+
+
+
+ /relationship +
+
+
+
- network-id + network-policy-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID representing unique key to this instance

 path @@ -80437,130 +96759,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + resource-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

resource-version for concurrency

 query @@ -80568,6 +96770,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -80651,10 +96848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-id + network-policy-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID representing unique key to this instance

 path @@ -80665,157 +96862,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -80825,29 +96871,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-assignment -
-
-
- -
default @@ -80870,35 +96893,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing ctag-assignment
-

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
delete an existing relationship
+

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Tags: Network
-

create or update an existing ctag-assignment

+

delete an existing relationship

application/json application/xml

-
-
-

ctag-assignment object that needs to be created or updated

-

-
-
-
-
- /ctag-assignment -
-
-
@@ -80914,10 +96925,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-id + network-policy-id -

Network ID, should be uuid. Unique across A&AI.

+

UUID representing unique key to this instance

 path @@ -80928,22 +96939,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

id.

- 		path - integer - - - -
@@ -80975,93 +96970,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing ctag-assignment
-

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

+
returns newvces
+

GET /network/newvces

Tags: Network
-

delete an existing ctag-assignment

+

returns newvces

-
- -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /newvces +
+
+
+ +
default @@ -81084,36 +97034,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+
returns newvce
+

GET /network/newvces/newvce/{vnf-id2}

Tags: Network
-

see node definition for valid relationships

+

returns newvce

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -81128,34 +97061,93 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -81167,6 +97159,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /newvce +
+
+
+ +
default @@ -81189,23 +97204,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+
create or update an existing newvce
+

PUT /network/newvces/newvce/{vnf-id2}

Tags: Network
-

delete an existing relationship

+

create or update an existing newvce

application/json application/xml

+
+
+

newvce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)

+

+
+
+
+
+ /newvce +
+
+
- network-id + 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 -

Network ID, should be uuid. Unique across A&AI.

+

Alternate name of VNF.

pathquery string -
- vlan-id-inner + vnf-type -

id.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery - integer + 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 -
@@ -81221,10 +97248,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -81235,22 +97262,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

id.

- 		path - integer - - - -
@@ -81282,17 +97293,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+
update an existing newvce
+

PATCH /network/newvces/newvce/{vnf-id2}

Tags: Network
-

see node definition for valid relationships

+

update an existing newvce

@@ -81301,13 +97312,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

newvce object that needs to be created or updated.

- /relationship + /newvce
@@ -81326,10 +97337,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -81371,17 +97382,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

+
delete an existing newvce
+

DELETE /network/newvces/newvce/{vnf-id2}

Tags: Network
-

delete an existing relationship

+

delete an existing newvce

@@ -81403,10 +97414,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -81417,6 +97428,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -81448,17 +97475,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns segmentation-assignments
-

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

+
returns l-interfaces
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

Tags: Network
-

returns segmentation-assignments

+

returns l-interfaces

@@ -81475,10 +97502,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -81491,70 +97518,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vnf-name -

Contrail FQDN for the network

+

Name of VNF.

 query @@ -81566,10 +97533,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + vnf-name2 -

the ASDC model id for this resource or service model.

+

Alternate name of VNF.

 query @@ -81581,10 +97548,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + vnf-type -

the ASDC model version for this resource or service model.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -81596,10 +97563,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + prov-status -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -81611,10 +97578,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + heat-stack-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -81650,7 +97617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /segmentation-assignments + /l-interfaces
@@ -81678,17 +97645,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns segmentation-assignment
-

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
returns l-interface
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

returns segmentation-assignment

+

returns l-interface

@@ -81705,10 +97672,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -81721,10 +97688,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name given to the interface

 path @@ -81737,25 +97704,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

- 		query - string - - -
- network-role + vnf-name -

Role the network plans - who defines these values?

+

Name of VNF.

 query @@ -81767,10 +97719,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + vnf-name2 -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

Alternate name of VNF.

 query @@ -81782,10 +97734,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vnf-type -

Heat stack id corresponding to this instance, managed by MSO

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -81797,10 +97749,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-network-fqdn + prov-status -

Contrail FQDN for the network

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -81812,10 +97764,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + heat-stack-id -

the ASDC model id for this resource or service model.

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -81827,10 +97779,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + interface-id -

the ASDC model version for this resource or service model.

+

ID of interface

 query @@ -81842,10 +97794,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + macaddr -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

MAC address for the interface

 query @@ -81857,10 +97809,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + network-name -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Name of the network

 query @@ -81896,7 +97848,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /segmentation-assignment + /l-interface
@@ -81924,17 +97876,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing segmentation-assignment
-

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
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 segmentation-assignment

+

create or update an existing l-interface

@@ -81943,13 +97895,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

segmentation-assignment object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)

- /segmentation-assignment + /l-interface
@@ -81968,10 +97920,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -81984,10 +97936,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name given to the interface

 path @@ -82029,23 +97981,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing segmentation-assignment
-

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+
update an existing l-interface
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing segmentation-assignment

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -82061,10 +98025,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -82077,10 +98041,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name given to the interface

 path @@ -82091,22 +98055,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -82138,35 +98086,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+
delete an existing l-interface
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

delete an existing l-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -82182,10 +98118,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -82198,10 +98134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name given to the interface

 path @@ -82212,6 +98148,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -82243,24 +98195,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+
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
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -82275,10 +98222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -82291,10 +98238,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + interface-name -

Route Table Reference id, UUID assigned to this instance.

+

Name given to the interface

 path @@ -82305,68 +98252,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + l3-interface-ipv4-address -

Network ID, should be uuid. Unique across A&AI.

+

IP address

 path @@ -82379,10 +98270,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vnf-name -

Name of the network, governed by some naming convention..

+

Name of VNF.

 query @@ -82394,10 +98285,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-role + vnf-name2 -

Role the network plans - who defines these values?

+

Alternate name of VNF.

 query @@ -82409,10 +98300,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + vnf-type -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -82439,10 +98345,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-network-fqdn + interface-id -

Contrail FQDN for the network

+

ID of interface

 query @@ -82454,10 +98360,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + macaddr -

the ASDC model id for this resource or service model.

+

MAC address for the interface

 query @@ -82469,10 +98375,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + network-name -

the ASDC model version for this resource or service model.

+

Name of the network

 query @@ -82484,10 +98390,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + vlan-id-inner -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

 query @@ -82499,10 +98420,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + neutron-subnet-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Neutron id of subnet that address belongs to

 query @@ -82538,7 +98459,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /subnets + /l3-interface-ipv4-address-list
@@ -82566,19 +98487,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns subnet
-

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
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
-

returns subnet

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -82593,10 +98531,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -82782,29 +98586,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /subnet -
-
-
- -
default @@ -82827,17 +98608,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing subnet
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing subnet

+

update an existing l3-interface-ipv4-address-list

@@ -82846,13 +98627,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

subnet object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /subnet + /l3-interface-ipv4-address-list
@@ -82871,10 +98652,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -82609,10 +98547,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

 path @@ -82625,152 +98563,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + l3-interface-ipv4-address -

Name associated with the subnet.

+

IP address

querypath string +
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -82887,10 +98668,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -82932,17 +98729,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing subnet
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

+
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 subnet

+

delete an existing l3-interface-ipv4-address-list

@@ -82964,10 +98761,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -82980,10 +98777,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -83041,19 +98854,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns host-routes
-

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes

+
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
-

returns host-routes

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -83068,10 +98898,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -83084,10 +98914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

 path @@ -83100,152 +98930,127 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + l3-interface-ipv4-address -

the ASDC model version for this resource or service model.

+

IP address

querypath 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 +

+
+
+ + + + + + + + + + + - + - + - + @@ -83257,29 +99062,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /host-routes -
-
-
- -
default @@ -83302,17 +99084,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns host-route
-

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+
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 host-route

+

returns l3-interface-ipv6-address-list

@@ -83329,10 +99111,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - -
- widget-model-id + vnf-id2 -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- widget-model-version + interface-name -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Name given to the interface

querypath string +
- subnet-name + l3-interface-ipv4-address -

Name associated with the subnet.

+

IP address

querypath string +
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -83345,10 +99127,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

 path @@ -83361,10 +99143,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- host-route-id + l3-interface-ipv6-address -

host-route id

+

IP address

 path @@ -83377,10 +99159,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vnf-name -

Name of the network, governed by some naming convention..

+

Name of VNF.

 query @@ -83392,10 +99174,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-role + vnf-name2 -

Role the network plans - who defines these values?

+

Alternate name of VNF.

 query @@ -83407,10 +99189,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + vnf-type -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -83437,10 +99234,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- contrail-network-fqdn + interface-id -

Contrail FQDN for the network

+

ID of interface

 query @@ -83452,10 +99249,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + macaddr -

the ASDC model id for this resource or service model.

+

MAC address for the interface

 query @@ -83467,10 +99264,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + network-name -

the ASDC model version for this resource or service model.

+

Name of the network

 query @@ -83482,14 +99279,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + vlan-id-inner -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Inner VLAN tag

 query - string + integer @@ -83497,10 +99294,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + neutron-network-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Neutron network id of the interface that address belongs to

 query @@ -83512,10 +99309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-name + neutron-subnet-id -

Name associated with the subnet.

+

Neutron id of subnet that address belongs to

 query @@ -83551,7 +99348,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /host-route + /l3-interface-ipv6-address-list
@@ -83579,17 +99376,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing host-route
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+
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 host-route

+

create or update an existing l3-interface-ipv6-address-list

@@ -83598,13 +99395,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

host-route object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /host-route + /l3-interface-ipv6-address-list
@@ -83623,10 +99420,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -83639,10 +99436,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

 path @@ -83655,10 +99452,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- host-route-id + l3-interface-ipv6-address -

host-route id

+

IP address

 path @@ -83700,23 +99497,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing host-route
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing host-route

+

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 +
+
+
@@ -83732,10 +99541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -83748,10 +99557,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

 path @@ -83764,10 +99573,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- host-route-id + l3-interface-ipv6-address -

host-route id

+

IP address

 path @@ -83778,22 +99587,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -83825,35 +99618,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -83869,42 +99650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - -
- network-id - -

Network ID, should be uuid. Unique across A&AI.

- 		path - string - - - -
- subnet-id - -

Subnet ID, should be UUID.

- 		path - string - - - -
- host-route-id + vnf-id2 -

host-route id

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -83915,73 +99664,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + - -
- network-id + interface-name -

Network ID, should be uuid. Unique across A&AI.

+

Name given to the interface

 path @@ -83994,10 +99682,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + l3-interface-ipv6-address -

Subnet ID, should be UUID.

+

IP address

 path @@ -84010,12 +99698,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- host-route-id + resource-version -

host-route id

+

resource-version for concurrency

pathquery string @@ -84055,11 +99743,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

+

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
@@ -84074,7 +99762,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -84099,10 +99787,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -84115,10 +99803,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -84160,11 +99864,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/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
@@ -84192,10 +99896,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-id + vnf-id2 -

Network ID, should be uuid. Unique across A&AI.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -84208,10 +99912,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subnet-id + interface-name -

Subnet ID, should be UUID.

+

Name given to the interface

 path @@ -84222,132 +99926,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + l3-interface-ipv6-address -

Alphabetical concatenation of lag-interface names

+

IP address

 path @@ -84367,29 +99951,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-link -
-
-
- -
default @@ -84412,17 +99973,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-link
-

PUT /network/lag-links/lag-link/{link-name}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

create or update an existing lag-link

+

see node definition for valid relationships

@@ -84431,13 +99992,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-link object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterface.json)

- /lag-link + /relationship
@@ -84456,10 +100017,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id2 -

Alphabetical concatenation of lag-interface names

+

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 @@ -84501,17 +100078,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing lag-link
-

DELETE /network/lag-links/lag-link/{link-name}

+
delete an existing relationship
+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

delete an existing lag-link

+

delete an existing relationship

@@ -84533,10 +100110,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id2 -

Alphabetical concatenation of lag-interface names

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -84549,12 +100126,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath string @@ -84594,36 +100171,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/lag-links/lag-link/{link-name}/relationship-list/relationship

+
returns sriov-vfs
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

see node definition for valid relationships

+

returns sriov-vfs

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -84638,10 +100198,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- link-name + vnf-id2 -

Alphabetical concatenation of lag-interface names

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -84652,73 +100212,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-name -

Alphabetical concatenation of lag-interface names

+

Name given to the interface

 path @@ -84729,51 +100228,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns logical-links
-

GET /network/logical-links

- Tags: - Network -
-
-
-

returns logical-links

- -
-

application/json application/xml

@@ -84796,7 +100374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /logical-links + /sriov-vfs
@@ -84824,17 +100402,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns logical-link
-

GET /network/logical-links/logical-link/{link-name}

+
returns sriov-vf
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns logical-link

+

returns sriov-vf

@@ -84851,10 +100429,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id2 -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -84867,25 +100445,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + interface-name -

the ASDC model id for this resource or service model.

+

Name given to the interface

querypath string +
- model-version-id + pci-id -

the ASDC model version for this resource or service model.

+

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
+ vnf-name + +

Name of VNF.

 query @@ -84897,10 +100492,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + vnf-name2 -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Alternate name of VNF.

 query @@ -84912,10 +100507,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + vnf-type -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 @@ -84942,47 +100537,266 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-id + heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+ 		query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+ 		query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+ 		query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + Network +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + + + - + - + - + @@ -84994,29 +100808,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /logical-link -
-
-
- -
default @@ -85039,17 +100830,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing logical-link
-

PUT /network/logical-links/logical-link/{link-name}

+
update an existing sriov-vf
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

create or update an existing logical-link

+

update an existing sriov-vf

@@ -85058,13 +100849,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

logical-link object that needs to be created or updated

+

sriov-vf object that needs to be created or updated.

- /logical-link + /sriov-vf
@@ -85083,10 +100874,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id2 -

UUID of the logical-link, SDNC generates this.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath string +
- circuit-id + interface-name -

Circuit id

+

Name given to the interface

querypath string +
- purpose + pci-id -

Reason for this entity, role it is playing

+

PCI ID used to identify the sriov-vf

querypath string +
- link-name + vnf-id2 -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

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 @@ -85128,17 +100951,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing logical-link
-

DELETE /network/logical-links/logical-link/{link-name}

+
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 logical-link

+

delete an existing sriov-vf

@@ -85160,10 +100983,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id2 -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

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 @@ -85221,11 +101076,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/logical-links/logical-link/{link-name}/relationship-list/relationship

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -85240,7 +101095,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -85265,10 +101120,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id2 -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

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 @@ -85310,11 +101197,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/logical-links/logical-link/{link-name}/relationship-list/relationship

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -85342,10 +101229,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- link-name + vnf-id2 -

e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ

+

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 @@ -85387,19 +101306,186 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns multicast-configurations
-

GET /network/multicast-configurations

+
returns vlans
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

returns multicast-configurations

+

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 @@ -85423,7 +101509,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /multicast-configurations + /vlans
@@ -85451,17 +101537,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns multicast-configuration
-

GET /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+
returns vlan
+

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

returns multicast-configuration

+

returns vlan

@@ -85478,10 +101564,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id2 -

Unique id of multicast configuration.

+

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 @@ -85492,6 +101610,156 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -85518,7 +101786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /multicast-configuration + /vlan
@@ -85546,17 +101814,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing multicast-configuration
-

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}

+
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 multicast-configuration

+

create or update an existing vlan

@@ -85565,13 +101833,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

multicast-configuration object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

- /multicast-configuration + /vlan
@@ -85590,10 +101858,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id2 -

Unique id of multicast configuration.

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -85604,73 +101872,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-name -

Unique id of multicast configuration.

+

Name given to the interface

 path @@ -85683,12 +101890,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath string @@ -85728,17 +101935,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+
update an existing vlan
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

see node definition for valid relationships

+

update an existing vlan

@@ -85747,13 +101954,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

vlan object that needs to be created or updated.

- /relationship + /vlan
@@ -85772,10 +101979,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id2 -

Unique id of multicast configuration.

+

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 @@ -85817,17 +102056,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/multicast-configurations/multicast-configuration/{multicast-configuration-id}/relationship-list/relationship

+
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 relationship

+

delete an existing vlan

@@ -85849,10 +102088,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- multicast-configuration-id + vnf-id2 -

Unique id of multicast configuration.

+

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 @@ -85863,6 +102134,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -85894,81 +102181,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
-
-
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}

+
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 network-policy

+

returns l3-interface-ipv4-address-list

@@ -85985,26 +102208,254 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + 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 -

UUID representing unique key to this instance

+

ID of interface

pathquery string -
- network-policy-fqdn + macaddr -

Contrail FQDN for the policy

+

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 @@ -86040,7 +102491,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-policy + /l3-interface-ipv4-address-list
@@ -86068,17 +102519,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing network-policy
-

PUT /network/network-policies/network-policy/{network-policy-id}

+
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 network-policy

+

create or update an existing l3-interface-ipv4-address-list

@@ -86087,13 +102538,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

network-policy object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /network-policy + /l3-interface-ipv4-address-list
@@ -86112,10 +102563,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + vnf-id2 -

UUID representing unique key to this instance

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86126,73 +102577,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-name -

UUID representing unique key to this instance

+

Name given to the interface

 path @@ -86205,12 +102595,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path string @@ -86250,17 +102656,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -86269,13 +102675,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -86294,10 +102700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-policy-id + vnf-id2 -

UUID representing unique key to this instance

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

 path @@ -86308,73 +102714,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-name -

UUID representing unique key to this instance

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -86416,83 +102793,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
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}

+
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
-

returns newvce

+

delete an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
@@ -86523,70 +102841,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + - + @@ -86605,29 +102912,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /newvce -
-
-
- -
default @@ -86650,17 +102934,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing newvce
-

PUT /network/newvces/newvce/{vnf-id2}

+
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
-

create or update an existing newvce

+

see node definition for valid relationships

@@ -86669,13 +102953,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

newvce object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /newvce + /relationship
@@ -86708,6 +102992,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + +
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name given to the interface

querypath string +
- vnf-type + vlan-interface -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

String that identifies the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

IP address

querypath string +
- heat-stack-id + resource-version -

Heat stack id corresponding to this instance, managed by MSO

+

resource-version for concurrency

 query @@ -86594,6 +102900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ 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 + + + +
@@ -86739,17 +103071,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing newvce
-

DELETE /network/newvces/newvce/{vnf-id2}

+
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 newvce

+

delete an existing relationship

@@ -86787,12 +103119,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path string @@ -86832,17 +103196,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

+
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 l-interfaces

+

returns l3-interface-ipv6-address-list

@@ -86875,55 +103239,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + interface-name -

Name of VNF.

+

Name given to the interface

querypath string +
- vnf-name2 + vlan-interface -

Alternate name of VNF.

+

String that identifies the interface

querypath string +
- vnf-type + l3-interface-ipv6-address -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

IP address

querypath string +
- prov-status + vnf-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name of VNF.

 query @@ -86935,10 +103302,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vnf-name2 -

Heat stack id corresponding to this instance, managed by MSO

+

Alternate name of VNF.

 query @@ -86948,123 +103315,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + vnf-type -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery string -
- interface-name + prov-status -

Name given to the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- vnf-name + heat-stack-id -

Name of VNF.

+

Heat stack id corresponding to this instance, managed by MSO

 query @@ -87076,10 +103362,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + interface-id -

Alternate name of VNF.

+

ID of interface

 query @@ -87091,10 +103377,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + macaddr -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

MAC address for the interface

 query @@ -87106,10 +103392,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + network-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name of the network

 query @@ -87121,14 +103407,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vlan-id-inner -

Heat stack id corresponding to this instance, managed by MSO

+

Inner VLAN tag

 query - string + integer @@ -87136,10 +103422,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vpn-key -

ID of interface

+

This indicates the customers VPN ID associated with this vlan

 query @@ -87151,10 +103437,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

+

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

 query @@ -87166,10 +103467,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-subnet-id -

Name of the network

+

Neutron id of subnet that address belongs to

 query @@ -87205,7 +103506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /l3-interface-ipv6-address-list
@@ -87233,17 +103534,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing l-interface
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
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 l-interface

+

create or update an existing l3-interface-ipv6-address-list

@@ -87252,13 +103553,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /l-interface + /l3-interface-ipv6-address-list
@@ -87307,6 +103608,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -87338,23 +103671,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing l-interface

+

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 +
+
+
@@ -87402,12 +103747,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- resource-version + vlan-interface -

resource-version for concurrency

+

String that identifies the interface

querypath + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -87447,19 +103808,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns l3-interface-ipv4-address-list

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -87506,10 +103872,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -87694,29 +103927,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -87739,17 +103949,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -87758,13 +103968,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /relationship
@@ -87815,7 +104025,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -87522,160 +103888,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + l3-interface-ipv6-address -

Neutron network id of the interface that address belongs to

+

IP address

querypath string +
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -87683,6 +103915,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- l3-interface-ipv4-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address

IP address

@@ -87860,17 +104086,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv4-address-list

+

delete an existing relationship

@@ -87924,10 +104150,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -87940,12 +104166,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -87985,11 +104211,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -88004,7 +104230,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvceLInterfacesLInterfaceVlansVlan.json)

@@ -88061,10 +104287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -88106,11 +104332,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: Network
@@ -88170,10 +104396,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -88215,19 +104441,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
see node definition for valid relationships
+

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkNewvcesNewvce.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -88253,210 +104496,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- -
- 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 - - +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - +
- neutron-subnet-id + vnf-id2 -

Neutron id of subnet that address belongs to

+

Unique id of VNF, can't use same attribute name right now until we promote this new object

querypath 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

@@ -88479,7 +104643,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /physical-links
@@ -88507,36 +104671,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns physical-link
+

GET /network/physical-links/physical-link/{link-name}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

returns physical-link

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -88551,26 +104698,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -88606,6 +104736,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /physical-link +
+
+
+ +
default @@ -88628,23 +104781,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing physical-link
+

PUT /network/physical-links/physical-link/{link-name}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

create or update an existing physical-link

application/json application/xml

+
+
+

physical-link object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)

+

+
+
+
+
+ /physical-link +
+
+
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -88583,18 +104714,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + circuit-id -

IP address

+

Circuit it

pathquery string -
@@ -88660,42 +104825,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- 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 + link-name -

IP address

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -88706,22 +104839,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -88753,17 +104870,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing physical-link
+

PATCH /network/physical-links/physical-link/{link-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing physical-link

@@ -88772,13 +104889,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

physical-link object that needs to be created or updated.

- /relationship + /physical-link
@@ -88797,42 +104914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + link-name -

IP address

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -88874,17 +104959,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
delete an existing physical-link
+

DELETE /network/physical-links/physical-link/{link-name}

Tags: Network
-

delete an existing relationship

+

delete an existing physical-link

@@ -88906,26 +104991,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -88938,12 +105007,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -88983,11 +105052,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -89002,7 +105071,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPhysicalLinksPhysicalLink.json)

@@ -89027,26 +105096,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -89088,11 +105141,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -89120,26 +105173,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + link-name -

Name given to the interface

+

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

 path @@ -89181,17 +105218,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
returns pnfs
+

GET /network/pnfs

Tags: Network
-

returns sriov-vfs

+

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

@@ -89208,26 +105309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 - -

Unique id of VNF, can't use same attribute name right now until we promote this new object

- 		path - string - - - -
- interface-name + pnf-name -

Name given to the interface

+

unique name of Physical Network Function.

 path @@ -89240,115 +105325,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + inv-status -

Name of the network

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -89384,7 +105364,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /pnf
@@ -89412,19 +105392,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vf
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing pnf
+

PUT /network/pnfs/pnf/{pnf-name}

Tags: Network
-

returns sriov-vf

+

create or update an existing pnf

+
+ +

application/json application/xml +

+
+
+

pnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)

+

+
+
+
+
+ /pnf +
+
+
+
@@ -89439,10 +105436,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -89453,12 +105450,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing pnf
+

PATCH /network/pnfs/pnf/{pnf-name}

+ Tags: + Network +
+
+
+

update an existing pnf

+ +
+
+ +

application/json application/xml +

+
+
+

pnf object that needs to be created or updated.

+

+
+
+
+
+ /pnf +
+
+
+
+
+ + + + + + + + + + + + +
- interface-name + pnf-name -

Name given to the interface

+

unique name of Physical Network Function.

 path @@ -89469,12 +105539,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -89674,29 +105641,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -89719,36 +105663,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns lag-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

Tags: Network
-

create or update an existing sriov-vf

+

returns lag-interfaces

-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated

-

-
-
-
-
- /sriov-vf -
-
-
-
- pci-id + pnf-name -

PCI ID used to identify the sriov-vf

+

unique name of Physical Network Function.

 path @@ -89487,175 +105618,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + resource-version -

Neutron network id of the interface

+

resource-version for concurrency

 query @@ -89663,6 +105629,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -89763,26 +105690,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -89818,6 +105728,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
default @@ -89840,24 +105773,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-vf
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
returns lag-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing sriov-vf

+

returns lag-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 + pnf-name -

Name given to the interface

+

unique name of Physical Network Function.

 path @@ -89795,18 +105706,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + inv-status -

PCI ID used to identify the sriov-vf

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
@@ -89872,10 +105800,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -89943,6 +105884,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
default @@ -89965,17 +105929,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
create or update an existing lag-interface
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing lag-interface

@@ -89984,13 +105948,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)

- /relationship + /lag-interface
@@ -90009,10 +105973,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -89891,7 +105819,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -89904,26 +105832,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + inv-status -

PCI ID used to identify the sriov-vf

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- resource-version + interface-id -

resource-version for concurrency

+

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -89931,7 +105873,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90028,23 +105992,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

+

Name that identifies the link aggregate interface

 path @@ -90086,23 +106034,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
update an existing lag-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+
+ /lag-interface +
+
+
@@ -90118,10 +106078,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90137,23 +106097,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

- 		path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

+

Name that identifies the link aggregate interface

 path @@ -90195,19 +106139,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

+
delete an existing lag-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

returns vlans

+

delete an existing lag-interface

+
+ +

application/json application/xml +

+
@@ -90222,10 +106171,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90241,7 +106190,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -90254,25 +106203,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

- 		query - string - - -
- vnf-name2 + resource-version -

Alternate name of VNF.

+

resource-version for concurrency

 query @@ -90280,44 +106214,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + +
- vnf-type + pnf-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

unique name of Physical Network Function.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name that identifies the link aggregate interface

querypath string +
- heat-stack-id + inv-status -

Heat stack id corresponding to this instance, managed by MSO

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -90344,25 +106337,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr - -

MAC address for the interface

- 		query - string - - -
- network-name + interface-role -

Name of the network

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -90398,7 +106376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l-interfaces
@@ -90426,17 +106404,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

returns vlan

+

returns l-interface

@@ -90453,10 +106431,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90472,7 +106450,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -90485,10 +106463,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -90501,70 +106479,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + inv-status -

Heat stack id corresponding to this instance, managed by MSO

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -90591,10 +106509,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + interface-role -

MAC address for the interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -90606,10 +106524,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-id -

Name of the network

+

ID of interface

 query @@ -90621,14 +106539,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + macaddr -

Inner VLAN tag

+

MAC address for the interface

 query - integer + string @@ -90636,10 +106554,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + network-name -

This indicates the customers VPN ID associated with this vlan

+

Name of the network

 query @@ -90675,7 +106593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l-interface
@@ -90703,17 +106621,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vlan
-

PUT /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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 vlan

+

create or update an existing l-interface

@@ -90722,13 +106640,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /vlan + /l-interface
@@ -90747,10 +106665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90766,7 +106684,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -90779,10 +106697,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -90824,23 +106742,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
update an existing l-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing vlan

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -90856,10 +106786,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90875,7 +106805,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -90888,10 +106818,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -90902,22 +106832,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -90949,19 +106863,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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
-

returns l3-interface-ipv4-address-list

+

delete an existing l-interface

+
+ +

application/json application/xml +

+
@@ -90976,10 +106895,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -90995,7 +106914,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -91008,10 +106927,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -91024,12 +106943,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -91038,72 +106957,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vnf-name + pnf-name -

Name of VNF.

+

unique name of Physical Network Function.

querypath string +
- vnf-name2 + interface-name -

Alternate name of VNF.

+

Name that identifies the link aggregate interface

querypath string +
- vnf-type + interface-name -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Name given to the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

IP address

querypath string +
- heat-stack-id + inv-status -

Heat stack id corresponding to this instance, managed by MSO

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -91130,10 +107109,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + interface-role -

MAC address for the interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -91145,10 +107124,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-id -

Name of the network

+

ID of interface

 query @@ -91160,14 +107139,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + macaddr -

Inner VLAN tag

+

MAC address for the interface

 query - integer + string @@ -91175,10 +107154,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + network-name -

This indicates the customers VPN ID associated with this vlan

+

Name of the network

 query @@ -91259,7 +107238,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -91287,11 +107266,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -91306,7 +107285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -91331,10 +107310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -91350,7 +107329,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -91363,10 +107342,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -91424,23 +107403,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

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 +
+
+
@@ -91456,10 +107447,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -91475,7 +107466,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -91488,10 +107479,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -91518,22 +107509,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -91565,35 +107540,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -91609,10 +107572,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -91628,7 +107591,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -91641,10 +107604,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -91671,6 +107634,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -91702,23 +107681,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -91734,10 +107725,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + - -
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -91753,7 +107744,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -91766,10 +107757,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -91827,19 +107818,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -91854,10 +107850,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -91873,7 +107869,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -91886,10 +107882,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -91902,7 +107898,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -91916,201 +107912,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -92120,29 +107921,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
default @@ -92165,36 +107943,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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
-

create or update an existing l3-interface-ipv6-address-list

+

returns 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 -
-
-
-
@@ -92209,10 +107970,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -92228,7 +107989,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -92241,10 +108002,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -92271,137 +108032,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + inv-status -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- interface-name + interface-id -

Name given to the interface

+

ID of interface

pathquery string -
- vlan-interface + interface-role -

String that identifies the interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

pathquery string -
- l3-interface-ipv6-address + interface-id -

IP address

+

ID of interface

pathquery string -
- resource-version + macaddr -

resource-version for concurrency

+

MAC address for the interface

 query @@ -92409,144 +108105,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-
- -
-

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 -
-
-
-
-
- - - - - - - - - - - - + - + - + - + @@ -92558,6 +108176,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv6-address-list +
+
+
+ +
default @@ -92580,23 +108221,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

delete an existing relationship

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
- vnf-id2 + network-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

Name of the network

pathquery string -
- interface-name + vlan-id-inner -

Name given to the interface

+

Inner VLAN tag

pathquery - string + integer -
- vlan-interface + neutron-network-id -

String that identifies the interface

+

Neutron network id of the interface that address belongs to

pathquery string -
- l3-interface-ipv6-address + neutron-subnet-id -

IP address

+

Neutron id of subnet that address belongs to

pathquery string -
@@ -92612,10 +108265,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -92631,7 +108284,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name given to the interface

+

Name that identifies the link aggregate interface

 path @@ -92644,10 +108297,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name given to the interface

 path @@ -92705,17 +108358,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -92724,13 +108377,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -92749,10 +108402,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -92781,10 +108450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -92826,17 +108495,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
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 relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -92858,10 +108527,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -92890,10 +108575,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -92904,6 +108589,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -92935,11 +108636,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+

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
@@ -92954,7 +108655,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -92979,10 +108680,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

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 @@ -93024,11 +108773,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/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
@@ -93056,10 +108805,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + pnf-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

unique name of Physical Network Function.

 path @@ -93070,132 +108819,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

- -
-
- - - - - - - - - - - - + + + + + + + + @@ -93230,29 +108876,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /physical-link -
-
-
- -
default @@ -93275,17 +108898,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing physical-link
-

PUT /network/physical-links/physical-link/{link-name}

+
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
-

create or update an existing physical-link

+

see node definition for valid relationships

@@ -93294,13 +108917,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

physical-link object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /physical-link + /relationship
@@ -93319,10 +108942,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
- link-name + interface-name -

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

Name that identifies the link aggregate interface

 path @@ -93208,17 +108837,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- circuit-id + interface-name -

Circuit it

+

Name given to the interface

querypath + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string +
- link-name + pnf-name -

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

unique name of Physical Network Function.

 path @@ -93333,73 +108956,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + interface-name -

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

Name that identifies the link aggregate interface

 path @@ -93412,12 +108974,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath string @@ -93457,35 +109019,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/physical-links/physical-link/{link-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -93501,10 +109051,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- link-name + pnf-name -

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

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 @@ -93546,24 +109128,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/physical-links/physical-link/{link-name}/relationship-list/relationship

+
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
-

delete an existing relationship

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -93578,10 +109155,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- link-name + pnf-name -

e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ

+

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 @@ -93592,51 +109201,100 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns pnfs
-

GET /network/pnfs

- Tags: - Network -
-
-
-

returns pnfs

- -
-

application/json application/xml

@@ -93659,7 +109317,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pnfs + /sriov-vfs
@@ -93687,17 +109345,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns pnf
-

GET /network/pnfs/pnf/{pnf-name}

+
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 pnf

+

returns sriov-vf

@@ -93728,6 +109386,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -93743,6 +109449,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -93769,7 +109610,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pnf + /sriov-vf
@@ -93797,17 +109638,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing pnf
-

PUT /network/pnfs/pnf/{pnf-name}

+
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 pnf

+

create or update an existing sriov-vf

@@ -93816,13 +109657,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

pnf object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /pnf + /sriov-vf
@@ -93855,6 +109696,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + + +
@@ -93886,23 +109775,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing pnf
-

DELETE /network/pnfs/pnf/{pnf-name}

+
update an existing sriov-vf
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing pnf

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -93934,12 +109835,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath string @@ -93948,68 +109849,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

- -
-
- - - - - - - - - - - - + @@ -94044,29 +109890,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interfaces -
-
-
- -
default @@ -94089,19 +109912,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interface
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+
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
-

returns lag-interface

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
- pnf-name + interface-name -

unique name of Physical Network Function.

+

Name given to the interface

 path @@ -94022,17 +109867,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + pci-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -94148,40 +109976,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -94200,29 +110031,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interface -
-
-
- -
default @@ -94245,17 +110053,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing lag-interface
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+
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
-

create or update an existing lag-interface

+

see node definition for valid relationships

@@ -94264,13 +110072,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /lag-interface + /relationship
@@ -94319,6 +110127,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + +
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name given to the interface

querypath string +
- interface-id + pci-id -

ID of interface

+

PCI ID used to identify the sriov-vf

querypath string +
- interface-role + resource-version -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

resource-version for concurrency

 query @@ -94189,6 +110019,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -94350,17 +110190,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing lag-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+
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 lag-interface

+

delete an existing relationship

@@ -94414,12 +110254,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path string @@ -94459,17 +110315,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

returns l-interfaces

+

returns vlans

@@ -94516,6 +110372,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
inv-status @@ -94561,6 +110433,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
@@ -94587,7 +110504,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /vlans
@@ -94615,17 +110532,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interface
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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 l-interface

+

returns vlan

@@ -94688,6 +110605,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
inv-status @@ -94778,6 +110711,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
@@ -94804,7 +110767,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /vlan
@@ -94832,17 +110795,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 l-interface

+

create or update an existing vlan

@@ -94851,13 +110814,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

- /l-interface + /vlan
@@ -94922,6 +110885,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -94953,17 +110932,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing vlan
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing l-interface

+

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

@@ -95031,6 +111147,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
resource-version @@ -95078,11 +111210,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -95151,6 +111283,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -95272,6 +111420,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -95328,7 +111506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -95356,11 +111534,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -95375,7 +111553,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -95446,6 +111624,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -95493,11 +111687,164 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -95571,6 +111918,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -95634,11 +111997,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -95653,7 +112016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -95724,6 +112087,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -95771,11 +112150,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -95849,6 +112228,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv4-address @@ -95896,11 +112291,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -95969,6 +112364,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -96090,6 +112501,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -96146,7 +112587,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -96174,11 +112615,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -96193,7 +112634,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -96264,6 +112705,175 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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 @@ -96311,11 +112921,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -96389,6 +112999,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -96452,11 +113078,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -96471,7 +113097,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -96542,6 +113168,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -96589,11 +113231,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -96667,6 +113309,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
l3-interface-ipv6-address @@ -96714,11 +113372,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -96733,7 +113391,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -96804,6 +113462,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -96835,11 +113509,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
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

+

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
@@ -96913,6 +113587,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
@@ -96944,19 +113634,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vfs
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

returns sriov-vfs

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -97001,112 +113708,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - -
@@ -97116,29 +113717,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -97161,19 +113739,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

returns sriov-vf

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -97218,28 +113801,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- pci-id + pnf-name -

PCI ID used to identify the sriov-vf

+

unique name of Physical Network Function.

 path @@ -97265,141 +113888,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -97426,7 +113914,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /p-interfaces
@@ -97454,36 +113942,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns p-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

create or update an existing sriov-vf

+

returns p-interface

-
- -

application/json application/xml -

-
-
-

sriov-vf object that needs to be created or updated

-

-
-
-
-
- /sriov-vf -
-
-
-
@@ -97517,7 +113988,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + @@ -97569,6 +114038,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
default @@ -97591,23 +114083,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing p-interface
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

delete an existing sriov-vf

+

create or update an existing p-interface

application/json application/xml

+
+
+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)

+

+
+
+
+
+ /p-interface +
+
+
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -97530,34 +114001,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + inv-status -

Name given to the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- pci-id + prov-status -

PCI ID used to identify the sriov-vf

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
@@ -97642,39 +114146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

+

Name that identifies the physical interface

 path @@ -97685,22 +114157,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -97732,17 +114188,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing p-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing p-interface

@@ -97751,13 +114207,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

p-interface object that needs to be created or updated.

- /relationship + /p-interface
@@ -97795,39 +114251,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

+

Name that identifies the physical interface

 path @@ -97869,17 +114293,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
delete an existing p-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

delete an existing p-interface

@@ -97920,23 +114344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the physical interface

 path @@ -97949,12 +114357,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + resource-version -

PCI ID used to identify the sriov-vf

+

resource-version for concurrency

pathquery string @@ -97994,17 +114402,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
returns l-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network
-

returns vlans

+

returns l-interfaces

@@ -98040,23 +114448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the physical interface

 path @@ -98084,70 +114476,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + prov-status -

Name of the network

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -98183,7 +114515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l-interfaces
@@ -98211,17 +114543,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
returns l-interface
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

returns vlan

+

returns l-interface

@@ -98257,7 +114589,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -98284,22 +114616,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
inv-status @@ -98317,25 +114633,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -98390,36 +114691,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
@@ -98446,7 +114717,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l-interface
@@ -98474,17 +114745,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 vlan

+

create or update an existing l-interface

@@ -98493,13 +114764,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

- /vlan + /l-interface
@@ -98537,7 +114808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -98564,22 +114835,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -98611,23 +114866,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing l-interface
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing vlan

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -98662,7 +114929,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name + +
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -98689,12 +114956,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + +
- vlan-interface + pnf-name -

String that identifies the interface

+

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 @@ -98752,11 +115112,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -98798,7 +115158,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -98825,22 +115185,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -98874,25 +115218,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -98962,36 +115291,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 @@ -99048,7 +115347,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -99076,11 +115375,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -99095,7 +115394,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -99139,7 +115438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -99168,10 +115467,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv4-address -

String that identifies the interface

+

IP address

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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 @@ -99229,11 +115649,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -99280,7 +115700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -99307,22 +115727,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -99386,11 +115790,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -99405,7 +115809,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -99449,7 +115853,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -99476,22 +115880,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -99539,11 +115927,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -99590,7 +115978,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -99617,22 +116005,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv4-address @@ -99680,11 +116052,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -99726,7 +116098,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -99753,22 +116125,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -99802,25 +116158,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -99890,36 +116231,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 @@ -99976,7 +116287,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -100004,11 +116315,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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}

+

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
@@ -100023,7 +116334,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -100067,148 +116378,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

+

Name that identifies the physical interface

 path @@ -100235,22 +116405,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -100267,22 +116421,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -100314,17 +116452,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -100333,13 +116471,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -100377,7 +116515,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -100404,22 +116542,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
l3-interface-ipv6-address @@ -100467,17 +116589,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -100518,7 +116640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -100547,10 +116669,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -100563,12 +116685,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -100608,11 +116730,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -100627,7 +116749,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -100671,7 +116793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -100700,10 +116822,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -100745,11 +116867,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -100796,7 +116918,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -100825,10 +116947,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -100870,11 +116992,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -100889,7 +117011,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterface.json)

@@ -100933,7 +117055,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -100975,11 +117113,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
@@ -101026,7 +117164,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -101068,17 +117222,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

+
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 p-interfaces

+

returns sriov-vfs

@@ -101109,6 +117263,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
inv-status @@ -101124,6 +117310,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -101150,7 +117396,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interfaces + /sriov-vfs
@@ -101178,17 +117424,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns p-interface
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+
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 p-interface

+

returns sriov-vf

@@ -101235,6 +117481,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
inv-status @@ -101265,6 +117543,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -101291,7 +117674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interface + /sriov-vf
@@ -101319,17 +117702,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing p-interface
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+
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 p-interface

+

create or update an existing sriov-vf

@@ -101338,13 +117721,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /p-interface + /sriov-vf
@@ -101393,6 +117776,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -101424,23 +117839,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing p-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

+
update an existing sriov-vf
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing p-interface

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -101488,12 +117915,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path string @@ -101533,19 +117976,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+
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
-

returns l-interfaces

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
@@ -101592,25 +118040,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -101629,29 +118095,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -101674,19 +118117,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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
-

returns l-interface

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /relationship +
+
+
+
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name given to the interface

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

 query @@ -101618,6 +118083,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -101749,77 +118209,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -101831,29 +118232,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -101876,35 +118254,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing l-interface

+

delete an existing relationship

application/json application/xml

-
-
-

l-interface object that needs to be created or updated

-

-
-
-
-
- /l-interface -
-
-
- 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 + pci-id -

Name of the network

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -101966,6 +118332,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -101997,24 +118379,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing l-interface
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

delete an existing l-interface

+

returns vlans

-
- -

application/json application/xml -

-
@@ -102077,10 +118454,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -102100,6 +118536,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
default @@ -102122,17 +118581,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv4-address-list

+

returns vlan

@@ -102197,10 +118656,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- resource-version + inv-status -

resource-version for concurrency

+

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 @@ -102088,7 +118525,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -102303,25 +118762,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id - -

Neutron network id of the interface that address belongs to

- 		query - string - - -
- neutron-subnet-id + vpn-key -

Neutron id of subnet that address belongs to

+

This indicates the customers VPN ID associated with this vlan

 query @@ -102357,7 +118801,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vlan
@@ -102385,17 +118829,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv4-address-list

+

create or update an existing vlan

@@ -102404,13 +118848,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /l3-interface-ipv4-address-list + /vlan
@@ -102477,10 +118921,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -102522,23 +118966,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing vlan
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated.

+

+
+
+
+
+ /vlan +
+
+
@@ -102602,10 +119058,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -102616,22 +119072,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -102663,35 +119103,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing vlan

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -102755,10 +119183,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -102769,6 +119197,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -102800,24 +119244,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -102880,82 +119319,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- 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 + vlan-interface -

unique name of Physical Network Function.

+

String that identifies the interface

 path @@ -102968,10 +119335,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name that identifies the physical interface

+

IP address

 path @@ -102984,42 +119351,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + inv-status -

Name given to the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- l3-interface-ipv6-address + prov-status -

IP address

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- inv-status + interface-id -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

ID of interface

 query @@ -103031,10 +119396,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + macaddr -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

MAC address for the interface

 query @@ -103046,10 +119411,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + network-name -

ID of interface

+

Name of the network

 query @@ -103061,14 +119426,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

+

Inner VLAN tag

 query - string + integer @@ -103076,10 +119441,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vpn-key -

Name of the network

+

This indicates the customers VPN ID associated with this vlan

 query @@ -103160,7 +119525,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -103188,17 +119553,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -103207,13 +119572,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -103280,7 +119645,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -103325,23 +119706,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

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 +
+
+
@@ -103405,10 +119798,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + +
- l3-interface-ipv6-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -103421,12 +119814,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -103466,35 +119859,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -103558,103 +119939,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- 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 + vlan-interface -

Name that identifies the physical interface

+

String that identifies the interface

 path @@ -103667,10 +119955,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -103683,12 +119971,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -103728,11 +120016,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -103747,7 +120035,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -103818,89 +120106,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + vlan-interface -

Name that identifies the physical interface

+

String that identifies the interface

 path @@ -103913,10 +120124,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -103958,19 +120169,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
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
-

returns sriov-vfs

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -104033,77 +120249,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -104115,29 +120288,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -104160,17 +120310,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

returns l3-interface-ipv6-address-list

@@ -104235,10 +120385,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + - - - - - - -
- 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 + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
- network-name + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -104326,14 +120492,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + vlan-id-inner -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Inner VLAN tag

 query - string + integer @@ -104341,10 +120507,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + vpn-key -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

This indicates the customers VPN ID associated with this vlan

 query @@ -104356,14 +120522,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + vlan-id-inner -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

Inner VLAN tag

 query - boolean + integer @@ -104374,7 +120540,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen neutron-network-id -

Neutron network id of the interface

+

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -104410,7 +120591,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l3-interface-ipv6-address-list
@@ -104438,17 +120619,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

@@ -104457,13 +120638,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /sriov-vf + /l3-interface-ipv6-address-list
@@ -104530,119 +120711,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -104655,10 +120727,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -104669,22 +120741,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -104716,17 +120772,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -104735,13 +120791,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -104808,10 +120864,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -104853,17 +120925,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -104933,10 +121005,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -104947,6 +121019,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -104978,19 +121082,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlans
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
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
-

returns vlans

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -105053,77 +121174,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -105135,29 +121213,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -105180,19 +121235,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlan
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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
-

returns vlan

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- 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 + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -105271,107 +121331,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -105383,29 +121354,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -105428,17 +121376,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing vlan

+

see node definition for valid relationships

@@ -105447,13 +121395,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

- /vlan + /relationship
@@ -105565,17 +121513,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 vlan

+

delete an existing relationship

@@ -105659,22 +121607,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- 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 + l3-interface-ipv6-address -

This indicates the customers VPN ID associated with this vlan

+

IP address

querypath string +
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -105706,19 +121638,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -105763,28 +121712,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - + +
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + pnf-name -

String that identifies the interface

+

unique name of Physical Network Function.

 path @@ -105797,10 +121791,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-name -

IP address

+

Name that identifies the physical interface

 path @@ -105811,57 +121805,100 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - - - - - - - - + - + + +
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- prov-status + pnf-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

unique name of Physical Network Function.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name that identifies the physical interface

querypath string +
- macaddr + inv-status -

MAC address for the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -105873,10 +121910,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + prov-status -

Name of the network

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -105886,57 +121923,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - -
- vlan-id-inner + pnf-name -

Inner VLAN tag

+

unique name of Physical Network Function.

querypath - integer + string +
- vpn-key + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the physical interface

querypath string +
- vlan-id-inner + pf-pci-id -

Inner VLAN tag

+

Identifier for the sriov-pf

querypath - integer + string +
- neutron-network-id + inv-status -

Neutron network id of the interface that address belongs to

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -105948,10 +122067,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + prov-status -

Neutron id of subnet that address belongs to

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -105987,7 +122106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /sriov-pf
@@ -106015,17 +122134,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv4-address-list

+

create or update an existing sriov-pf

@@ -106034,13 +122153,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

- /l3-interface-ipv4-address-list + /sriov-pf
@@ -106091,42 +122210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + pf-pci-id -

IP address

+

Identifier for the sriov-pf

 path @@ -106168,23 +122255,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing sriov-pf
+

PATCH /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

update an existing sriov-pf

application/json application/xml

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
@@ -106232,10 +122331,87 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + +
- interface-name + pf-pci-id -

Name given to the interface

+

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 @@ -106248,10 +122424,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name that identifies the physical interface

 path @@ -106264,10 +122440,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + pf-pci-id -

IP address

+

Identifier for the sriov-pf

 path @@ -106325,11 +122501,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: Network
@@ -106344,7 +122520,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnfPInterfacesPInterfaceSriovPfsSriovPf.json)

@@ -106401,42 +122577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address + pf-pci-id -

IP address

+

Identifier for the sriov-pf

 path @@ -106478,11 +122622,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

Tags: Network
@@ -106542,26 +122686,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + pf-pci-id -

String that identifies the interface

+

Identifier for the sriov-pf

 path @@ -106572,12 +122700,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkPnfsPnf.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - -
- l3-interface-ipv4-address + pnf-name -

IP address

+

unique name of Physical Network Function.

 path @@ -106619,19 +122820,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -106660,12 +122866,132 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + + +
- interface-name + route-table-reference-id -

Name that identifies the physical interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -106678,26 +123004,121 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + route-table-reference-fqdn -

Name given to the interface

+

FQDN entry in the route table.

pathquery 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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+
+
+
+ /route-table-reference +
+
+
+
+
+ + + + + + + + + + + + +
- vlan-interface + route-table-reference-id -

String that identifies the interface

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -106708,12 +123129,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing route-table-reference
+

PATCH /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

update an existing route-table-reference

+ +
+
+ +

application/json application/xml +

+
+
+

route-table-reference object that needs to be created or updated.

+

+
+
+
+
+ /route-table-reference +
+
+
+
+
+ + + + + + + + + + + + +
- l3-interface-ipv6-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -106724,102 +123218,89 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - + +
- 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 + route-table-reference-id -

Name of the network

+

Route Table Reference id, UUID assigned to this instance.

querypath string +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key + resource-version -

This indicates the customers VPN ID associated with this vlan

+

resource-version for concurrency

 query @@ -106827,57 +123308,220 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkRouteTableReferencesRouteTableReference.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - + + +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + route-table-reference-id -

Neutron network id of the interface that address belongs to

+

Route Table Reference id, UUID assigned to this instance.

querypath 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 +

+
+
+ + + + + + + + + + + - +
- neutron-subnet-id + route-table-reference-id -

Neutron id of subnet that address belongs to

+

Route Table Reference id, UUID assigned to this instance.

querypath 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

@@ -106900,7 +123544,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /site-pair-sets
@@ -106928,36 +123572,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns site-pair-set
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

returns site-pair-set

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -106972,74 +123599,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - + +
- 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 + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -107059,6 +123622,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair-set +
+
+
+ +
default @@ -107081,23 +123667,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing site-pair-set
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

create or update an existing site-pair-set

application/json application/xml

+
+
+

site-pair-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)

+

+
+
+
+
+ /site-pair-set +
+
+
@@ -107113,74 +123711,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -107191,22 +123725,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -107238,17 +123756,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing site-pair-set
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

see node definition for valid relationships

+

update an existing site-pair-set

@@ -107257,13 +123775,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

site-pair-set object that needs to be created or updated.

- /relationship + /site-pair-set
@@ -107282,74 +123800,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + site-pair-set-id -

IP address

+

Unique id of site pair set.

 path @@ -107391,17 +123845,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
delete an existing site-pair-set
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

delete an existing relationship

+

delete an existing site-pair-set

@@ -107423,58 +123877,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + site-pair-set-id -

String that identifies the interface

+

Unique id of site pair set.

 path @@ -107487,12 +123893,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -107532,11 +123938,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network
@@ -107551,7 +123957,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSet.json)

@@ -107576,58 +123982,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + site-pair-set-id -

String that identifies the interface

+

Unique id of site pair set.

 path @@ -107669,11 +124027,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network
@@ -107701,10 +124059,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -107715,12 +124073,68 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + +
- interface-name + site-pair-set-id -

Name that identifies the physical interface

+

Unique id of site pair set.

 path @@ -107731,12 +124145,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + @@ -110139,7 +126860,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /routing-instance + /vce
@@ -110167,17 +126888,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing vce
+

PUT /network/vces/vce/{vnf-id}

Tags: Network
-

create or update an existing routing-instance

+

create or update an existing vce

@@ -110186,13 +126907,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

routing-instance object that needs to be created or updated

+

vce object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)

- /routing-instance + /vce
@@ -110211,26 +126932,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - -
- interface-name + site-pair-set-id -

Name given to the interface

+

Unique id of site pair set.

 path @@ -107749,10 +124242,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + routing-instance-id -

String that identifies the interface

+

Unique id of routing instance

 path @@ -107772,6 +124265,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /routing-instance +
+
+
+ +
default @@ -107794,17 +124310,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing routing-instance

@@ -107813,13 +124329,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

routing-instance object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

- /relationship + /routing-instance
@@ -107838,10 +124354,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -107854,10 +124370,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the physical interface

+

Unique id of routing instance

 path @@ -107899,23 +124415,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+
update an existing routing-instance
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network
-

delete an existing relationship

+

update an existing routing-instance

application/json application/xml

+
+
+

routing-instance object that needs to be created or updated.

+

+
+
+
+
+ /routing-instance +
+
+
@@ -107931,10 +124459,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -107947,10 +124475,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the physical interface

+

Unique id of routing instance

 path @@ -107992,19 +124520,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-pfs
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+
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
-

returns sriov-pfs

+

delete an existing routing-instance

+
+ +

application/json application/xml +

+
@@ -108019,10 +124552,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - @@ -108088,29 +124607,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-pfs -
-
-
- -
default @@ -108133,19 +124629,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-pf
-

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+
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
-

returns sriov-pf

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstance.json)

+

+
+
+
+
+ /relationship +
+
+
+
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -108035,10 +124568,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the physical interface

+

Unique id of routing instance

 path @@ -108051,25 +124584,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- prov-status + resource-version -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

resource-version for concurrency

 query @@ -108077,6 +124595,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -108160,10 +124673,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -108176,10 +124689,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the physical interface

+

Unique id of routing instance

 path @@ -108190,12 +124703,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - + @@ -108245,29 +124805,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-pf -
-
-
- -
default @@ -108290,36 +124827,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing sriov-pf

+

returns site-pairs

-
- -

application/json application/xml -

-
-
-

sriov-pf object that needs to be created or updated

-

-
-
-
-
- /sriov-pf -
-
-
-
- pf-pci-id + site-pair-set-id -

Identifier for the sriov-pf

+

Unique id of site pair set.

 path @@ -108208,32 +124782,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- prov-status + routing-instance-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique id of routing instance

querypath string +
@@ -108334,26 +124854,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the physical interface

+

Unique id of site pair set.

 path @@ -108366,10 +124870,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + routing-instance-id -

Identifier for the sriov-pf

+

Unique id of routing instance

 path @@ -108389,6 +124893,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pairs +
+
+
+ +
default @@ -108411,24 +124938,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing sriov-pf
-

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+
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
-

delete an existing sriov-pf

+

returns site-pair

-
- -

application/json application/xml -

-
@@ -108438,31 +124960,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - + + + - + + + + + + + + + + + + + + + + + + + + + +
- pnf-name - -

unique name of Physical Network Function.

- 		path - string - - - -
- interface-name + site-pair-set-id -

Name that identifies the physical interface

+

Unique id of site pair set.

 path @@ -108475,10 +124981,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + routing-instance-id -

Identifier for the sriov-pf

+

Unique id of routing instance

 path @@ -108491,12 +124997,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + site-pair-id -

resource-version for concurrency

+

unique identifier of probe

querypath string @@ -108514,6 +125020,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /site-pair +
+
+
+ +
default @@ -108536,17 +125065,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

see node definition for valid relationships

+

create or update an existing site-pair

@@ -108555,13 +125084,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

site-pair object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

- /relationship + /site-pair
@@ -108580,10 +125109,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -108596,10 +125125,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the physical interface

+

Unique id of routing instance

 path @@ -108612,10 +125141,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + site-pair-id -

Identifier for the sriov-pf

+

unique identifier of probe

 path @@ -108657,23 +125186,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
update an existing site-pair
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network
-

delete an existing relationship

+

update an existing site-pair

application/json application/xml

+
+
+

site-pair object that needs to be created or updated.

+

+
+
+
+
+ /site-pair +
+
+
@@ -108689,10 +125230,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -109078,7 +125674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-table-reference + /class-of-service
@@ -109106,17 +125702,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing route-table-reference
-

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

+
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 route-table-reference

+

create or update an existing class-of-service

@@ -109125,13 +125721,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

route-table-reference object that needs to be created or updated

+

class-of-service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

- /route-table-reference + /class-of-service
@@ -109150,10 +125746,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

Unique id of site pair set.

 path @@ -108705,10 +125246,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name that identifies the physical interface

+

Unique id of routing instance

 path @@ -108721,10 +125262,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + site-pair-id -

Identifier for the sriov-pf

+

unique identifier of probe

 path @@ -108766,35 +125307,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing site-pair

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -108810,10 +125339,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

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 @@ -108824,6 +125385,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -108855,24 +125432,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+
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
-

delete an existing relationship

+

returns classes-of-service

-
- -

application/json application/xml -

-
@@ -108887,10 +125459,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- pnf-name + site-pair-set-id -

unique name of Physical Network Function.

+

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 @@ -108905,47 +125509,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
-

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

@@ -108968,7 +125531,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-table-references + /classes-of-service
@@ -108996,17 +125559,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns route-table-reference
-

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

+
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 route-table-reference

+

returns class-of-service

@@ -109023,10 +125586,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-id + site-pair-set-id -

Route Table Reference id, UUID assigned to this instance.

+

Unique id of site pair set.

 path @@ -109039,17 +125602,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-fqdn + routing-instance-id -

FQDN entry in the route table.

+

Unique id of routing instance

querypath + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

+ 		path string +
- route-table-reference-id + site-pair-set-id -

Route Table Reference id, UUID assigned to this instance.

+

Unique id of site pair set.

 path @@ -109164,73 +125760,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + routing-instance-id -

Route Table Reference id, UUID assigned to this instance.

+

Unique id of routing instance

 path @@ -109243,12 +125778,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + site-pair-id -

resource-version for concurrency

+

unique identifier of probe

querypath + string + + + +
+ cos + +

unique identifier of probe

+ 		path string @@ -109288,17 +125839,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

+
update an existing class-of-service
+

PATCH /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

Tags: Network
-

see node definition for valid relationships

+

update an existing class-of-service

@@ -109307,13 +125858,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

class-of-service object that needs to be created or updated.

- /relationship + /class-of-service
@@ -109332,10 +125883,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-id + site-pair-set-id -

Route Table Reference id, UUID assigned to this instance.

+

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 @@ -109377,17 +125976,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

+
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 relationship

+

delete an existing class-of-service

@@ -109409,10 +126008,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-id + site-pair-set-id -

Route Table Reference id, UUID assigned to this instance.

+

Unique id of site pair set.

 path @@ -109423,132 +126022,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + routing-instance-id -

Unique id of site pair set.

+

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

 path @@ -109559,6 +126070,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -109568,29 +126095,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pair-set -
-
-
- -
default @@ -109613,17 +126117,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing site-pair-set
-

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+
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
-

create or update an existing site-pair-set

+

see node definition for valid relationships

@@ -109632,13 +126136,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

site-pair-set object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePairClassesOfServiceClassOfService.json)

- /site-pair-set + /relationship
@@ -109671,6 +126175,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + + +
@@ -109702,17 +126254,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing site-pair-set
-

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+
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 site-pair-set

+

delete an existing relationship

@@ -109750,12 +126302,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + routing-instance-id -

resource-version for concurrency

+

Unique id of routing instance

querypath + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

+ 		path string @@ -109795,11 +126379,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/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

Tags: Network
@@ -109814,7 +126398,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkSitePairSetsSitePairSetRoutingInstancesRoutingInstanceSitePairsSitePair.json)

@@ -109853,6 +126437,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
@@ -109884,11 +126500,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/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
@@ -109930,6 +126546,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ routing-instance-id + +

Unique id of routing instance

+ 		path + string + + + +
+ site-pair-id + +

unique identifier of probe

+ 		path + string + + + +
@@ -109961,50 +126609,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns routing-instances
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

+
returns vces
+

GET /network/vces

Tags: Network
-

returns routing-instances

+

returns vces

-
- - - - - - - - - - - - - - - - - - - -
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
-

application/json application/xml @@ -110028,7 +126645,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /routing-instances + /vces
@@ -110056,17 +126673,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns routing-instance
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+
returns vce
+

GET /network/vces/vce/{vnf-id}

Tags: Network
-

returns routing-instance

+

returns vce

@@ -110083,10 +126700,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110099,18 +126716,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + 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 routing instance

+

Unique ID of VPE connected to this VCE.

pathquery string -
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
- routing-instance-id + vnf-id -

Unique id of routing instance

+

Unique id of VNF. This is unique across the graph.

 path @@ -110272,23 +126977,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing routing-instance
-

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

+
update an existing vce
+

PATCH /network/vces/vce/{vnf-id}

Tags: Network
-

delete an existing routing-instance

+

update an existing vce

application/json application/xml

+
+
+

vce object that needs to be created or updated.

+

+
+
+
+
+ /vce +
+
+
@@ -110304,26 +127021,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
- routing-instance-id + vnf-id -

Unique id of routing instance

+

Unique id of VNF. This is unique across the graph.

 path @@ -110334,22 +127035,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -110381,35 +127066,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing vce
+

DELETE /network/vces/vce/{vnf-id}

Tags: Network
-

see node definition for valid relationships

+

delete an existing vce

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -110425,10 +127098,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + +
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110441,12 +127114,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + resource-version -

Unique id of routing instance

+

resource-version for concurrency

pathquery string @@ -110486,24 +127159,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns entitlements
+

GET /network/vces/vce/{vnf-id}/entitlements

Tags: Network
-

delete an existing relationship

+

returns entitlements

-
- -

application/json application/xml -

-
@@ -110518,10 +127186,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -110557,6 +127329,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /entitlements +
+
+
+ +
default @@ -110579,17 +127374,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns site-pairs
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

+
returns entitlement
+

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

returns site-pairs

+

returns entitlement

@@ -110606,10 +127401,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110534,18 +127202,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + vnf-name -

Unique id of routing instance

+

Name of VNF.

pathquery + 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 -
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110622,10 +127417,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the entitlement group the resource comes from, should be uuid.

+ 		path + string + + + +
+ resource-uuid + +

Unique ID of an entitlement resource.

 path @@ -110636,6 +127447,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -110662,7 +127593,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /site-pairs + /entitlement
@@ -110690,19 +127621,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
create or update an existing entitlement
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

returns site-pair

+

create or update an existing entitlement

+
+ +

application/json application/xml +

+
+
+

entitlement object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)

+

+
+
+
+
+ /entitlement +
+
+
+
@@ -110717,10 +127665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110733,10 +127681,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -110749,10 +127697,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of an entitlement resource.

 path @@ -110772,29 +127720,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pair -
-
-
- -
default @@ -110817,17 +127742,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing entitlement
+

PATCH /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

create or update an existing site-pair

+

update an existing entitlement

@@ -110836,13 +127761,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

site-pair object that needs to be created or updated

+

entitlement object that needs to be created or updated.

- /site-pair + /entitlement
@@ -110861,10 +127786,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110877,10 +127802,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -110893,10 +127818,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of an entitlement resource.

 path @@ -110938,17 +127863,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
delete an existing entitlement
+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing site-pair

+

delete an existing entitlement

@@ -110970,10 +127895,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -110986,10 +127911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -111002,10 +127927,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of an entitlement resource.

 path @@ -111063,19 +127988,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
-

returns classes-of-service

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceEntitlementsEntitlement.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -111090,10 +128032,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -111305,7 +128405,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /class-of-service + /licenses
@@ -111333,36 +128433,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns license
+

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

create or update an existing class-of-service

+

returns license

-
- -

application/json application/xml -

-
-
-

class-of-service object that needs to be created or updated

-

-
-
-
-
- /class-of-service -
-
-
-
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -111106,10 +128048,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the entitlement group the resource comes from, should be uuid.

 path @@ -111122,10 +128064,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of an entitlement resource.

 path @@ -111145,29 +128087,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK +
+ default
-
+
-

successful operation

+

Response codes found in response codes.

- +
-
- -
- /classes-of-service -
-
-
- +
+
+
+ + + + + +
+
+
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 @@ -111190,17 +128218,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
returns licenses
+

GET /network/vces/vce/{vnf-id}/licenses

Tags: Network
-

returns class-of-service

+

returns licenses

@@ -111217,10 +128245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -111233,50 +128261,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + vnf-name -

Unique id of routing instance

+

Name of VNF.

pathquery string -
- site-pair-id + vnf-name2 -

unique identifier of probe

+

Alternate name of VNF.

pathquery string -
- cos + vnf-type -

unique identifier of probe

+

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

pathquery + 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 -
@@ -111377,10 +128460,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -111448,6 +128635,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /license +
+
+
+ +
default @@ -111470,23 +128680,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing license
+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing class-of-service

+

create or update an existing license

application/json application/xml

+
+
+

license object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)

+

+
+
+
+
+ /license +
+
+
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -111393,10 +128476,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -111409,10 +128492,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of a license resource.

 path @@ -111425,18 +128508,122 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + vnf-name -

unique identifier of probe

+

Name of VNF.

pathquery + 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 -
@@ -111502,26 +128724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
- routing-instance-id + vnf-id -

Unique id of routing instance

+

Unique id of VNF. This is unique across the graph.

 path @@ -111534,10 +128740,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + group-uuid -

unique identifier of probe

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -111550,10 +128756,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + resource-uuid -

unique identifier of probe

+

Unique ID of a license resource.

 path @@ -111564,22 +128770,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -111611,17 +128801,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing license
+

PATCH /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

see node definition for valid relationships

+

update an existing license

@@ -111630,13 +128820,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

license object that needs to be created or updated.

- /relationship + /license
@@ -111655,26 +128845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id - -

Unique id of site pair set.

- 		path - string - - - -
- routing-instance-id + vnf-id -

Unique id of routing instance

+

Unique id of VNF. This is unique across the graph.

 path @@ -111687,10 +128861,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + group-uuid -

unique identifier of probe

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -111703,10 +128877,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + resource-uuid -

unique identifier of probe

+

Unique ID of a license resource.

 path @@ -111748,17 +128922,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
delete an existing license
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing relationship

+

delete an existing license

@@ -111780,10 +128954,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -111796,10 +128970,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -111812,10 +128986,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of a license resource.

 path @@ -111828,12 +129002,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cos + resource-version -

unique identifier of probe

+

resource-version for concurrency

pathquery string @@ -111873,11 +129047,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -111892,7 +129066,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVceLicensesLicense.json)

@@ -111917,10 +129091,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -111933,10 +129107,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -111949,10 +129123,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of a license resource.

 path @@ -111994,11 +129168,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -112026,10 +129200,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-set-id + vnf-id -

Unique id of site pair set.

+

Unique id of VNF. This is unique across the graph.

 path @@ -112042,10 +129216,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- routing-instance-id + group-uuid -

Unique id of routing instance

+

Unique ID for the license group the resource belongs to, should be uuid.

 path @@ -112058,10 +129232,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- site-pair-id + resource-uuid -

unique identifier of probe

+

Unique ID of a license resource.

 path @@ -112103,19 +129277,170 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vces
-

GET /network/vces

+
returns port-groups
+

GET /network/vces/vce/{vnf-id}/port-groups

Tags: Network
-

returns vces

+

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 @@ -112139,7 +129464,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /vces + /port-groups
@@ -112167,17 +129492,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vce
-

GET /network/vces/vce/{vnf-id}

+
returns port-group
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

returns vce

+

returns port-group

@@ -112208,6 +129533,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-id + +

Unique ID of the interface

+ 		path + string + + + +
vnf-name @@ -112328,6 +129669,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -112354,7 +129740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vce + /port-group
@@ -112382,17 +129768,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vce
-

PUT /network/vces/vce/{vnf-id}

+
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 vce

+

create or update an existing port-group

@@ -112401,13 +129787,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vce object that needs to be created or updated

+

port-group object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)

- /vce + /port-group
@@ -112440,6 +129826,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-id + +

Unique ID of the interface

+ 		path + string + + + +
@@ -112471,23 +129873,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vce
-

DELETE /network/vces/vce/{vnf-id}

+
update an existing port-group
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

delete an existing vce

+

update an existing port-group

application/json application/xml

+
+
+

port-group object that needs to be created or updated.

+

+
+
+
+
+ /port-group +
+
+
@@ -112517,6 +129931,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + +
+ 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 @@ -112564,17 +130087,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlements
-

GET /network/vces/vce/{vnf-id}/entitlements

+
returns cvlan-tags
+

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

Tags: Network
-

returns entitlements

+

returns cvlan-tags

@@ -112605,6 +130128,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-id + +

Unique ID of the interface

+ 		path + string + + + +
vnf-name @@ -112725,6 +130264,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -112751,7 +130335,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlements + /cvlan-tags
@@ -112779,17 +130363,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns entitlement
-

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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 entitlement

+

returns cvlan-tag-entry

@@ -112822,10 +130406,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Unique ID of the interface

 path @@ -112838,14 +130422,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + cvlan-tag -

Unique ID of an entitlement resource.

+

See mis-na-virtualization-platform.yang

 path - string + integer @@ -112972,148 +130556,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 -
-
-
-
-
- - - - - - - - - - - - + - + - + @@ -113125,6 +130610,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /cvlan-tag-entry +
+
+
+ +
default @@ -113147,23 +130655,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing entitlement
-

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+
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
-

delete an existing entitlement

+

create or update an existing cvlan-tag-entry

application/json application/xml

+
+
+

cvlan-tag-entry object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

+

+
+
+
+
+ /cvlan-tag-entry +
+
+
- vnf-id + port-group-id -

Unique id of VNF. This is unique across the graph.

+

Unique ID for port group in vmware

pathquery string -
- group-uuid + switch-name -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

DVS or standard switch name (should be non-null for port groups associated with DVS)

pathquery string -
- resource-uuid + heat-stack-id -

Unique ID of an entitlement resource.

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
@@ -113195,10 +130715,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + + + + + + + - - - - - - - - - - - - - -
- group-uuid + interface-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Unique ID of the interface

 path @@ -113211,30 +130731,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + cvlan-tag -

Unique ID of an entitlement resource.

+

See mis-na-virtualization-platform.yang

 path - string - - - -
- resource-version - -

resource-version for concurrency

- 		query - string + integer @@ -113272,17 +130776,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+
update an existing cvlan-tag-entry
+

PATCH /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Tags: Network
-

see node definition for valid relationships

+

update an existing cvlan-tag-entry

@@ -113291,13 +130795,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

cvlan-tag-entry object that needs to be created or updated.

- /relationship + /cvlan-tag-entry
@@ -113332,10 +130836,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Unique ID of the interface

 path @@ -113348,14 +130852,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + cvlan-tag -

Unique ID of an entitlement resource.

+

See mis-na-virtualization-platform.yang

 path - string + integer @@ -113393,17 +130897,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

+
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 relationship

+

delete an existing cvlan-tag-entry

@@ -113441,10 +130945,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid + interface-id -

Unique ID for the entitlement group the resource comes from, should be uuid.

+

Unique ID of the interface

 path @@ -113457,12 +130961,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-uuid + cvlan-tag -

Unique ID of an entitlement resource.

+

See mis-na-virtualization-platform.yang

 path + integer + + + +
+ resource-version + +

resource-version for concurrency

+ 		query string @@ -113502,19 +131022,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns licenses
-

GET /network/vces/vce/{vnf-id}/licenses

+
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
-

returns licenses

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroupCvlanTagsCvlanTagEntry.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -113545,122 +131082,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -113672,29 +131121,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /licenses -
-
-
- -
default @@ -113717,19 +131143,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns license
-

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
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
-

returns license

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- 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 + interface-id -

Heat stack id corresponding to this instance, managed by MSO

+

Unique ID of the interface

querypath string +
- vpe-id + cvlan-tag -

Unique ID of VPE connected to this VCE.

+

See mis-na-virtualization-platform.yang

querypath - string + integer +
@@ -113744,170 +131175,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -113919,29 +131230,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /license -
-
-
- -
default @@ -113964,17 +131252,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing license
-

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network
-

create or update an existing license

+

see node definition for valid relationships

@@ -113983,13 +131271,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVcePortGroupsPortGroup.json)

- /license + /relationship
@@ -114024,26 +131312,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- 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 + vnf-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- heat-stack-id + interface-id -

Heat stack id corresponding to this instance, managed by MSO

+

Unique ID of the interface

querypath string +
- vpe-id + cvlan-tag -

Unique ID of VPE connected to this VCE.

+

See mis-na-virtualization-platform.yang

querypath - string + integer +
- group-uuid - -

Unique ID for the license group the resource belongs to, should be uuid.

- 		path - string - - - -
- resource-uuid + interface-id -

Unique ID of a license resource.

+

Unique ID of the interface

 path @@ -114085,17 +131357,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing license
-

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network
-

delete an existing license

+

delete an existing relationship

@@ -114133,26 +131405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-uuid - -

Unique ID for the license group the resource belongs to, should be uuid.

- 		path - string - - - -
- resource-uuid + interface-id -

Unique ID of a license resource.

+

Unique ID of the interface

 path @@ -114163,22 +131419,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -114210,11 +131450,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

Tags: Network
@@ -114229,7 +131469,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVcesVce.json)

@@ -114268,38 +131508,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - - -
@@ -114331,11 +131539,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

+

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

Tags: Network
@@ -114377,38 +131585,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - - -
@@ -114440,17 +131616,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns port-groups
-

GET /network/vces/vce/{vnf-id}/port-groups

+
returns vnfcs
+

GET /network/vnfcs

Tags: Network
-

returns port-groups

+

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

@@ -114467,10 +131707,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -114483,10 +131723,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name + nfc-naming-code -

Name of VNF.

+

Short code that is used in naming instances of the item being modeled

 query @@ -114498,10 +131738,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + nfc-function -

Alternate name of VNF.

+

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

 query @@ -114513,10 +131753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + prov-status -

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 of this vnfc

 query @@ -114528,10 +131768,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + ipaddress-v4-oam-vip -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

Oam V4 vip address of this vnfc

 query @@ -114543,14 +131783,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + in-maint -

Regional way of organizing pservers, source of truth should define values

 query - string + boolean @@ -114558,10 +131797,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + is-closed-loop-disabled -

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + boolean + + +
+ group-notation + +

Group notation of VNFC

 query @@ -114573,10 +131826,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + model-invariant-id -

Heat stack id corresponding to this instance, managed by MSO

+

the ASDC model id for this resource or service model.

 query @@ -114588,10 +131841,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + model-version-id -

Unique ID of VPE connected to this VCE.

+

the ASDC model version for this resource or service model.

 query @@ -114627,7 +131880,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /port-groups + /vnfc
@@ -114655,19 +131908,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns port-group
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+
create or update an existing vnfc
+

PUT /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

returns port-group

+

create or update an existing vnfc

+
+ +

application/json application/xml +

+
+
+

vnfc object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)

+

+
+
+
+
+ /vnfc +
+
+
+
@@ -114682,10 +131952,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -114696,12 +131966,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vnfc
+

PATCH /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

update an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+

vnfc object that needs to be created or updated.

+

+
+
+
+
+ /vnfc +
+
+
+
+
+ + + + + + + + + + + + +
- interface-id + vnfc-name -

Unique ID of the interface

+

Unique ID of vnfc.

 path @@ -114712,27 +132055,89 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - + + + +
- vnf-name + vnfc-name -

Name of VNF.

+

Unique ID of vnfc.

querypath string +
- vnf-name2 + resource-version -

Alternate name of VNF.

+

resource-version for concurrency

 query @@ -114740,29 +132145,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - - - - - + + + + + + + + + + + + + + - -
+ vnfc-name + +

Unique ID of vnfc.

+ 		path + string + + +
- vnf-type + l3-interface-ipv4-address -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

IP address

querypath string +
- service-id + nfc-naming-code -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

+

Short code that is used in naming instances of the item being modeled

 query @@ -114774,10 +132253,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + nfc-function -

Regional way of organizing pservers, source of truth should define values

+

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

 query @@ -114792,7 +132271,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

prov status of this vnfc

 query @@ -114804,10 +132283,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + ipaddress-v4-oam-vip -

Heat stack id corresponding to this instance, managed by MSO

+

Oam V4 vip address of this vnfc

 query @@ -114819,10 +132298,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + in-maint -

Unique ID of VPE connected to this VCE.

+ 		query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

 query @@ -114834,10 +132341,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- port-group-id + model-invariant-id -

Unique ID for port group in vmware

+

the ASDC model id for this resource or service model.

 query @@ -114849,10 +132356,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- switch-name + model-version-id -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

the ASDC model version for this resource or service model.

 query @@ -114864,10 +132371,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vlan-id-inner -

Heat stack id corresponding to this instance, managed by MSO

+

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 @@ -114903,7 +132440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /port-group + /l3-interface-ipv4-address-list
@@ -114931,17 +132468,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing port-group
-

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+
create or update an existing l3-interface-ipv4-address-list
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

create or update an existing port-group

+

create or update an existing l3-interface-ipv4-address-list

@@ -114950,13 +132487,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

port-group object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

- /port-group + /l3-interface-ipv4-address-list
@@ -114975,10 +132512,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -114991,10 +132528,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv4-address -

Unique ID of the interface

+

IP address

 path @@ -115036,23 +132573,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing port-group
-

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing port-group

+

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 +
+
+
@@ -115068,10 +132617,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -115084,10 +132633,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv4-address -

Unique ID of the interface

+

IP address

 path @@ -115098,22 +132647,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -115145,19 +132678,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns cvlan-tags
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns cvlan-tags

+

delete an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
@@ -115172,10 +132710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -115188,10 +132726,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv4-address -

Unique ID of the interface

+

IP address

 path @@ -115204,100 +132742,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + resource-version -

Heat stack id corresponding to this instance, managed by MSO

+

resource-version for concurrency

 query @@ -115305,66 +132753,205 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + + +
- vpe-id + vnfc-name -

Unique ID of VPE connected to this VCE.

+

Unique ID of vnfc.

querypath string +
- port-group-id + l3-interface-ipv4-address -

Unique ID for port group in vmware

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + @@ -115376,29 +132963,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /cvlan-tags -
-
-
- -
default @@ -115421,17 +132985,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns cvlan-tag-entry
-

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

+
returns l3-interface-ipv6-address-list
+

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

returns cvlan-tag-entry

+

returns l3-interface-ipv6-address-list

@@ -115448,10 +133012,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- + - - - - - - - - - - - - - - - - - - - - -
- switch-name + vnfc-name -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

Unique ID of vnfc.

querypath string +
- heat-stack-id + l3-interface-ipv4-address -

Heat stack id corresponding to this instance, managed by MSO

+

IP address

querypath string +
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -115464,10 +133028,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -115480,26 +133044,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + nfc-naming-code -

See mis-na-virtualization-platform.yang

+

Short code that is used in naming instances of the item being modeled

pathquery - integer + string -
- vnf-name + nfc-function -

Name of VNF.

+

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

 query @@ -115511,10 +133074,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name2 + prov-status -

Alternate name of VNF.

+

prov status of this vnfc

 query @@ -115526,10 +133089,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-type + ipaddress-v4-oam-vip -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

+

Oam V4 vip address of this vnfc

 query @@ -115541,14 +133104,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-id + in-maint -

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

 query - string + boolean @@ -115556,14 +133118,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- regional-resource-zone + is-closed-loop-disabled -

Regional way of organizing pservers, source of truth should define values

 query - string + boolean @@ -115571,10 +133132,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + group-notation -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Group notation of VNFC

 query @@ -115586,10 +133147,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + model-invariant-id -

Heat stack id corresponding to this instance, managed by MSO

+

the ASDC model id for this resource or service model.

 query @@ -115601,10 +133162,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + model-version-id -

Unique ID of VPE connected to this VCE.

+

the ASDC model version for this resource or service model.

 query @@ -115616,14 +133177,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- port-group-id + vlan-id-inner -

Unique ID for port group in vmware

+

Inner VLAN tag

 query - string + integer @@ -115631,10 +133192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- switch-name + neutron-network-id -

DVS or standard switch name (should be non-null for port groups associated with DVS)

+

Neutron network id of the interface that address belongs to

 query @@ -115646,10 +133207,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + neutron-subnet-id -

Heat stack id corresponding to this instance, managed by MSO

+

Neutron id of subnet that address belongs to

 query @@ -115685,7 +133246,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cvlan-tag-entry + /l3-interface-ipv6-address-list
@@ -115713,17 +133274,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing l3-interface-ipv6-address-list
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing cvlan-tag-entry

+

create or update an existing l3-interface-ipv6-address-list

@@ -115732,13 +133293,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

cvlan-tag-entry object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

- /cvlan-tag-entry + /l3-interface-ipv6-address-list
@@ -115757,135 +133318,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vnfc-name -

Unique ID of the interface

+

Unique ID of vnfc.

 path @@ -115898,28 +133334,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + l3-interface-ipv6-address -

See mis-na-virtualization-platform.yang

+

IP address

 path - integer - - - -
- resource-version - -

resource-version for concurrency

- 		query string @@ -115959,17 +133379,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -115978,13 +133398,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv6-address-list
@@ -116003,10 +133423,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -116019,10 +133439,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -116033,22 +133453,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag - -

See mis-na-virtualization-platform.yang

- 		path - integer - - - -
@@ -116080,17 +133484,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -116112,10 +133516,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -116128,10 +133532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -116144,14 +133548,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cvlan-tag + resource-version -

See mis-na-virtualization-platform.yang

+

resource-version for concurrency

pathquery - integer + string @@ -116189,11 +133593,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -116208,7 +133612,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfcL3InterfaceIpv6AddressList.json)

@@ -116233,10 +133637,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -116249,10 +133653,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -116294,11 +133698,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
@@ -116326,10 +133730,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -116342,10 +133746,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + l3-interface-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -116387,11 +133791,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vces/vce/{vnf-id}/relationship-list/relationship

+

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network
@@ -116406,7 +133810,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVnfcsVnfc.json)

@@ -116431,10 +133835,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -116476,11 +133880,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

+

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Tags: Network
@@ -116508,10 +133912,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -116553,17 +133957,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vip-ipv4-address-list
-

GET /network/vip-ipv4-address-list/{vip-ipv4-address}

+
returns vpls-pes
+

GET /network/vpls-pes

Tags: Network
-

returns vip-ipv4-address-list

+

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

@@ -116580,10 +134048,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv4-address + equipment-name -

IP address

 path @@ -116596,40 +134063,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + prov-status -

Neutron id of subnet that address belongs to

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -116665,7 +134102,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vip-ipv4-address-list + /vpls-pe
@@ -116693,17 +134130,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vip-ipv4-address-list
-

PUT /network/vip-ipv4-address-list/{vip-ipv4-address}

+
create or update an existing vpls-pe
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

create or update an existing vip-ipv4-address-list

+

create or update an existing vpls-pe

@@ -116712,13 +134149,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vip-ipv4-address-list object that needs to be created or updated

+

vpls-pe object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)

- /vip-ipv4-address-list + /vpls-pe
@@ -116737,10 +134174,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv4-address + equipment-name -

IP address

 path @@ -116782,23 +134218,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vip-ipv4-address-list
-

DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}

+
update an existing vpls-pe
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

delete an existing vip-ipv4-address-list

+

update an existing vpls-pe

application/json application/xml

+
+
+

vpls-pe object that needs to be created or updated.

+

+
+
+
+
+ /vpls-pe +
+
+
@@ -116814,10 +134262,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- vip-ipv4-address + equipment-name -

IP address

 path @@ -116828,22 +134275,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -116875,35 +134306,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

+
delete an existing vpls-pe
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Tags: Network
-

see node definition for valid relationships

+

delete an existing vpls-pe

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -116919,10 +134338,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- vip-ipv4-address + equipment-name -

IP address

 path @@ -116933,6 +134351,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -116964,24 +134398,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

+
returns lag-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

Tags: Network
-

delete an existing relationship

+

returns lag-interfaces

-
- -

application/json application/xml -

-
@@ -116996,10 +134425,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- vip-ipv4-address + equipment-name -

IP address

 path @@ -117010,6 +134438,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+ 		query + string + + +
@@ -117019,6 +134462,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
default @@ -117041,17 +134507,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vip-ipv6-address-list
-

GET /network/vip-ipv6-address-list/{vip-ipv6-address}

+
returns lag-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

returns vip-ipv6-address-list

+

returns lag-interface

@@ -117068,10 +134534,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + equipment-name -

IP address

 path @@ -117084,14 +134549,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ prov-status + +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query - integer + string @@ -117099,10 +134580,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + interface-id -

Neutron network id of the interface that address belongs to

+

ID of interface

 query @@ -117114,10 +134595,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + interface-role -

Neutron id of subnet that address belongs to

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -117153,7 +134634,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vip-ipv6-address-list + /lag-interface
@@ -117181,17 +134662,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vip-ipv6-address-list
-

PUT /network/vip-ipv6-address-list/{vip-ipv6-address}

+
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 vip-ipv6-address-list

+

create or update an existing lag-interface

@@ -117200,13 +134681,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vip-ipv6-address-list object that needs to be created or updated

+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

- /vip-ipv6-address-list + /lag-interface
@@ -117225,10 +134706,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + equipment-name -

IP address

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

 path @@ -117270,23 +134766,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vip-ipv6-address-list
-

DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}

+
update an existing lag-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing vip-ipv6-address-list

+

update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated.

+

+
+
+
+
+ /lag-interface +
+
+
@@ -117302,10 +134810,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -117669,7 +135210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vip-ipv6-address + equipment-name -

IP address

 path @@ -117318,12 +134825,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath string @@ -117363,35 +134870,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+
delete an existing lag-interface
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

delete an existing lag-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -117407,10 +134902,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- vip-ipv6-address + equipment-name -

IP address

 path @@ -117421,6 +134915,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -117452,24 +134978,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+
returns l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

Tags: Network
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -117484,10 +135005,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vip-ipv6-address + equipment-name -

IP address

 path @@ -117498,51 +135018,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vnfcs
-

GET /network/vnfcs

- Tags: - Network -
-
-
-

returns vnfcs

- -
-

application/json application/xml

@@ -117565,7 +135105,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vnfcs + /l-interfaces
@@ -117593,17 +135133,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vnfc
-

GET /network/vnfcs/vnfc/{vnfc-name}

+
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 vnfc

+

returns l-interface

@@ -117620,10 +135160,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

 path @@ -117636,32 +135175,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nfc-naming-code + interface-name -

Short code that is used in naming instances of the item being modeled

+

Name that identifies the link aggregate interface

querypath string +
- nfc-function + interface-name -

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+

Name given to the interface

querypath string +
-

prov status of this vnfc

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -117681,10 +135222,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipaddress-v4-oam-vip + interface-id -

Oam V4 vip address of this vnfc

+

ID of interface

 query @@ -117696,27 +135237,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + interface-role +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query - boolean + string @@ -117724,10 +135252,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-notation + interface-id -

Group notation of VNFC

+

ID of interface

 query @@ -117739,10 +135267,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + macaddr -

the ASDC model id for this resource or service model.

+

MAC address for the interface

 query @@ -117754,10 +135282,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + network-name -

the ASDC model version for this resource or service model.

+

Name of the network

 query @@ -117793,7 +135321,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vnfc + /l-interface
@@ -117821,17 +135349,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vnfc
-

PUT /network/vnfcs/vnfc/{vnfc-name}

+
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 vnfc

+

create or update an existing l-interface

@@ -117840,13 +135368,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vnfc object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /vnfc + /l-interface
@@ -117865,10 +135393,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -117910,23 +135469,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vnfc
-

DELETE /network/vnfcs/vnfc/{vnfc-name}

+
update an existing l-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing vnfc

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -117942,10 +135513,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + +
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -118095,7 +135806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - + @@ -118796,7 +136755,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status - - - - - - - + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ equipment-name + + path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -118003,11 +135713,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv4-address-list
-

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -118030,10 +135740,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

 path @@ -118046,10 +135755,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

 path @@ -118062,32 +135771,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nfc-naming-code + interface-name -

Short code that is used in naming instances of the item being modeled

+

Name given to the interface

querypath string +
- nfc-function + l3-interface-ipv4-address -

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+

IP address

querypath string +
-

prov status of this vnfc

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -118107,10 +135818,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipaddress-v4-oam-vip + interface-id -

Oam V4 vip address of this vnfc

+

ID of interface

 query @@ -118122,27 +135833,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + interface-role +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query - boolean + string @@ -118150,10 +135848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-notation + interface-id -

Group notation of VNFC

+

ID of interface

 query @@ -118165,10 +135863,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + macaddr -

the ASDC model id for this resource or service model.

+

MAC address for the interface

 query @@ -118180,10 +135878,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + network-name -

the ASDC model version for this resource or service model.

+

Name of the network

 query @@ -118264,7 +135962,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /l3-interface-ipv4-address-list
@@ -118292,11 +135990,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv4-address-list
-

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -118311,7 +136009,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -118336,10 +136034,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -118397,11 +136126,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
+
+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated.

+

+
+
+
+
+ /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/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+

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
@@ -118429,10 +136294,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -118506,11 +136402,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

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
@@ -118525,7 +136421,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -118550,10 +136446,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name + + path + string + + + +
+ interface-name -

Unique ID of vnfc.

+

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -118611,11 +136538,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/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
@@ -118643,10 +136570,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -118704,11 +136662,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
returns l3-interface-ipv6-address-list
-

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -118731,10 +136689,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

 path @@ -118747,10 +136704,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

 path @@ -118763,32 +136720,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nfc-naming-code + interface-name -

Short code that is used in naming instances of the item being modeled

+

Name given to the interface

querypath string +
- nfc-function + l3-interface-ipv6-address -

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

+

IP address

querypath string +
-

prov status of this vnfc

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -118808,10 +136767,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipaddress-v4-oam-vip + interface-id -

Oam V4 vip address of this vnfc

+

ID of interface

 query @@ -118823,27 +136782,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + interface-role +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query - boolean + string @@ -118851,10 +136797,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-notation + interface-id -

Group notation of VNFC

+

ID of interface

 query @@ -118866,10 +136812,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + macaddr -

the ASDC model id for this resource or service model.

+

MAC address for the interface

 query @@ -118881,10 +136827,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + network-name -

the ASDC model version for this resource or service model.

+

Name of the network

 query @@ -118965,7 +136911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv6-address-list
@@ -118993,11 +136939,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
create or update an existing l3-interface-ipv6-address-list
-

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+

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
@@ -119012,7 +136958,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -119037,10 +136983,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -119098,23 +137075,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

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 +
+
+
@@ -119130,10 +137119,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- vnfc-name + equipment-name -

Unique ID of vnfc.

 path @@ -119146,10 +137134,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

 path @@ -119162,12 +137150,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string @@ -119207,35 +137211,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -119251,10 +137243,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- vnfc-name + equipment-name -

Unique ID of vnfc.

 path @@ -119267,10 +137258,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

 path @@ -119281,73 +137272,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - + + + + + + +
- vnfc-name + interface-name -

Unique ID of vnfc.

+

Name given to the interface

 path @@ -119374,6 +137304,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -119405,11 +137351,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

+

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
@@ -119424,7 +137370,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -119449,10 +137395,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

+ 		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 @@ -119494,11 +137487,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/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
@@ -119526,10 +137519,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnfc-name + equipment-name -

Unique ID of vnfc.

 path @@ -119540,131 +137532,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

- -
-
- - - - - - - - - - - - + + + + + + + + @@ -119699,29 +137589,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpls-pe -
-
-
- -
default @@ -119744,17 +137611,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vpls-pe
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}

+
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
-

create or update an existing vpls-pe

+

see node definition for valid relationships

@@ -119763,13 +137630,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vpls-pe object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterface.json)

- /vpls-pe + /relationship
@@ -119801,6 +137668,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + +
- equipment-name + interface-name +

Name that identifies the link aggregate interface

 path @@ -119677,17 +137550,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name given to the interface

querypath + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path string +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
@@ -119832,17 +137731,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vpls-pe
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

+
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 vpls-pe

+

delete an existing relationship

@@ -119879,12 +137778,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the link aggregate interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path string @@ -119924,17 +137839,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns lag-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

+
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 lag-interfaces

+

returns sriov-vfs

@@ -119964,6 +137879,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
prov-status @@ -119979,6 +137926,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -120005,7 +138027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /sriov-vfs
@@ -120033,17 +138055,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns lag-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
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 lag-interface

+

returns sriov-vf

@@ -120089,6 +138111,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
prov-status @@ -120134,6 +138188,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -120160,7 +138319,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /sriov-vf
@@ -120188,17 +138347,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing lag-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}

+
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 lag-interface

+

create or update an existing sriov-vf

@@ -120207,13 +138366,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

lag-interface object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /lag-interface + /sriov-vf
@@ -120261,88 +138420,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

+

Name given to the interface

 path @@ -120355,12 +138438,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -120400,19 +138483,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

+
update an existing sriov-vf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

returns l-interfaces

+

update an existing sriov-vf

+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
@@ -120458,47 +138558,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -120510,29 +138597,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -120555,19 +138619,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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
-

returns l-interface

+

delete an existing sriov-vf

+
+ +

application/json application/xml +

+
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + pci-id -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -120629,85 +138698,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -120726,29 +138737,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -120771,17 +138759,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing l-interface

+

see node definition for valid relationships

@@ -120790,13 +138778,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /l-interface + /relationship
@@ -120860,6 +138848,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- 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 + pci-id -

MAC address for the interface

+

PCI ID used to identify the sriov-vf

querypath string +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

 query @@ -120715,6 +138725,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -120891,17 +138895,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 l-interface

+

delete an existing relationship

@@ -120970,12 +138974,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + pci-id -

resource-version for concurrency

+

PCI ID used to identify the sriov-vf

querypath string @@ -121015,17 +139019,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv4-address-list

+

returns vlans

@@ -121087,22 +139091,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
prov-status @@ -121135,40 +139123,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + interface-role -

MAC address for the interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

 query @@ -121180,10 +139138,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + interface-id -

Name of the network

+

ID of interface

 query @@ -121195,25 +139153,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + macaddr -

Neutron network id of the interface that address belongs to

+

MAC address for the interface

 query @@ -121225,10 +139168,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + network-name -

Neutron id of subnet that address belongs to

+

Name of the network

 query @@ -121264,7 +139207,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /vlans
@@ -121292,36 +139235,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing l3-interface-ipv4-address-list

+

returns vlan

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -121383,10 +139309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -121397,6 +139323,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -121406,6 +139452,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -121428,23 +139497,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
@@ -121507,10 +139588,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -121521,22 +139602,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -121568,17 +139633,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing vlan
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

see node definition for valid relationships

+

update an existing vlan

@@ -121587,13 +139652,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

vlan object that needs to be created or updated.

- /relationship + /vlan
@@ -121659,10 +139724,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -121704,17 +139769,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 relationship

+

delete an existing vlan

@@ -121783,10 +139848,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + vlan-interface -

IP address

+

String that identifies the interface

 path @@ -121797,6 +139862,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -121828,17 +139909,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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-ipv6-address-list

+

returns l3-interface-ipv4-address-list

@@ -121902,7 +139983,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -122021,6 +140118,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -122077,7 +140204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -122105,17 +140232,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

@@ -122124,13 +140251,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

- /l3-interface-ipv6-address-list + /l3-interface-ipv4-address-list
@@ -122196,118 +140323,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -122320,7 +140339,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -122334,22 +140353,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -122381,17 +140384,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -122400,13 +140403,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

l3-interface-ipv4-address-list object that needs to be created or updated.

- /relationship + /l3-interface-ipv4-address-list
@@ -122472,7 +140475,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address

IP address

@@ -122517,17 +140536,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -122549,9 +140568,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name + equipment-name + + path + string + + + +
+ interface-name +

Name that identifies the link aggregate interface

 path @@ -122567,7 +140602,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name -

Name that identifies the link aggregate interface

+

Name given to the interface

 path @@ -122580,10 +140615,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name given to the interface

+

String that identifies the interface

 path @@ -122596,7 +140631,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -122610,6 +140645,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -122641,11 +140692,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
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

+

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
@@ -122660,7 +140711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -122730,88 +140781,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + vlan-interface -

Name that identifies the link aggregate interface

+

String that identifies the interface

 path @@ -122824,10 +140799,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv4-address -

Name given to the interface

+

IP address

 path @@ -122869,19 +140844,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

returns sriov-vfs

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -122943,92 +140923,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -123040,29 +140962,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -123085,17 +140984,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

returns l3-interface-ipv6-address-list

@@ -123159,10 +141058,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + +
- 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 + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
- network-name + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -123265,14 +141180,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + vlan-id-inner -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Inner VLAN tag

 query - string + integer @@ -123280,10 +141195,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + vpn-key -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

This indicates the customers VPN ID associated with this vlan

 query @@ -123295,14 +141210,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + vlan-id-inner -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

Inner VLAN tag

 query - boolean + integer @@ -123313,7 +141228,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen neutron-network-id -

Neutron network id of the interface

+

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -123349,7 +141279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l3-interface-ipv6-address-list
@@ -123377,17 +141307,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

create or update an existing l3-interface-ipv6-address-list

@@ -123396,13 +141326,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

- /sriov-vf + /l3-interface-ipv6-address-list
@@ -123468,10 +141398,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -123513,23 +141459,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing sriov-vf

+

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 +
+
+
@@ -123592,10 +141550,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -123608,12 +141566,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -123653,35 +141611,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -123744,10 +141690,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -123758,6 +141720,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -123789,23 +141767,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -123868,10 +141858,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -123913,19 +141919,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
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
-

returns vlans

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -123987,92 +141998,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -124084,29 +142037,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -124129,19 +142059,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns vlan

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
- 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 + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -124217,126 +142164,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 - - -
@@ -124346,29 +142173,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -124391,35 +142195,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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
-

create or update an existing vlan

+

delete an existing relationship

application/json application/xml

-
-
-

vlan object that needs to be created or updated

-

-
-
-
-
- /vlan -
-
-
@@ -124527,23 +142319,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

delete an existing vlan

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPeLagInterfacesLagInterface.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -124588,54 +142392,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- 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 - - - -
@@ -124667,19 +142423,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
delete an existing relationship
+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

returns l3-interface-ipv4-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -124723,210 +142484,83 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
- 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 + equipment-name -

Neutron network id of the interface that address belongs to

querypath string +
- neutron-subnet-id + prov-status -

Neutron id of subnet that address belongs to

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

 query @@ -124962,7 +142596,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /p-interfaces
@@ -124990,36 +142624,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns p-interface
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

returns p-interface

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -125052,23 +142669,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - + @@ -125120,6 +142719,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
default @@ -125142,23 +142764,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing p-interface
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

create or update an existing p-interface

application/json application/xml

+
+
+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)

+

+
+
+
+
+ /p-interface +
+
+
-

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the physical interface

 path @@ -125081,34 +142682,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + prov-status -

String that identifies the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- l3-interface-ipv4-address + prov-status -

IP address

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
@@ -125192,55 +142826,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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

+

Name that identifies the physical interface

 path @@ -125251,22 +142837,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -125298,17 +142868,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing p-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

see node definition for valid relationships

+

update an existing p-interface

@@ -125317,13 +142887,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

p-interface object that needs to be created or updated.

- /relationship + /p-interface
@@ -125360,7 +142930,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -125371,12 +142941,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - -
- interface-name + equipment-name -

Name given to the interface

 path @@ -125389,10 +143019,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + interface-name -

String that identifies the interface

+

Name that identifies the physical interface

 path @@ -125405,12 +143035,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -125450,24 +143080,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
returns l-interfaces
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -125500,23 +143125,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - + @@ -125568,6 +143175,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -125590,17 +143220,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv6-address-list

+

returns l-interface

@@ -125635,7 +143265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Name that identifies the link aggregate interface

- 		path - string - - - -
- interface-name - -

Name given to the interface

+

Name that identifies the physical interface

 path @@ -125529,34 +143138,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + prov-status -

String that identifies the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- l3-interface-ipv4-address + prov-status -

IP address

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -125662,38 +143292,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
prov-status @@ -125711,25 +143309,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + prov-status -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -125784,81 +143367,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - -
@@ -125885,7 +143393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l-interface
@@ -125913,17 +143421,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 l3-interface-ipv6-address-list

+

create or update an existing l-interface

@@ -125932,13 +143440,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

- /l3-interface-ipv6-address-list + /l-interface
@@ -125975,7 +143483,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -126002,38 +143510,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
@@ -126065,23 +143541,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing l-interface
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

update an existing l-interface

application/json application/xml

+
+
+

l-interface object that needs to be created or updated.

+

+
+
+
+
+ /l-interface +
+
+
@@ -126115,7 +143603,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - - - - - - - - - - - - - -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -126142,54 +143630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 - - - -
@@ -126221,35 +143661,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing l-interface

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -126283,7 +143711,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - +
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -126312,28 +143740,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -126373,24 +143785,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

delete an existing relationship

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -126423,7 +143830,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -126452,23 +143859,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -126482,264 +143873,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + prov-status +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- interface-name + prov-status -

Name that identifies the link aggregate interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- interface-name + interface-id -

Name given to the interface

+

ID of interface

pathquery string -
- vlan-interface + macaddr -

String that identifies the interface

+

MAC address for the interface

pathquery 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 -

-
-
- - - - - - - - - - - - + - + - + - + @@ -126751,110 +144002,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- default +
+ 200 OK
-
+
-

Response codes found in response codes.

+

successful operation

- +
-
- -
-
- - - - - -
-
-
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 + network-name +

Name of the network

pathquery string -
- interface-name + vlan-id-inner -

Name that identifies the link aggregate interface

+

Inner VLAN tag

pathquery - string + integer -
- interface-name + neutron-network-id -

Name given to the interface

+

Neutron network id of the interface that address belongs to

pathquery string -
- vlan-interface + neutron-subnet-id -

String that identifies the interface

+

Neutron id of subnet that address belongs to

pathquery string -
- - - - - - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

- 		path - string - - - -
-
+
-
-

application/json application/xml -

- -
+
+ /l3-interface-ipv4-address-list +
+
+
+ +
default @@ -126877,23 +144047,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+
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
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -126927,7 +144109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -126938,67 +144120,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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

- -
-
- - - - - - - - - - - - + @@ -127033,29 +144161,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interfaces -
-
-
- -
default @@ -127078,19 +144183,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns p-interface

+

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 + interface-name +

Name given to the interface

 path @@ -127011,17 +144138,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

IP address

querypath string +
@@ -127136,32 +144258,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -127173,29 +144297,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interface -
-
-
- -
default @@ -127218,35 +144319,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing p-interface
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+
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
-

create or update an existing p-interface

+

delete an existing l3-interface-ipv4-address-list

application/json application/xml

-
-
-

p-interface object that needs to be created or updated

-

-
-
-
-
- /p-interface -
-
-
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name given to the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
@@ -127291,6 +144380,54 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
+ 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 + + + +
@@ -127322,23 +144459,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing p-interface
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}

+
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
-

delete an existing p-interface

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -127385,12 +144534,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + +
- resource-version + interface-name -

resource-version for concurrency

+

Name given to the interface

querypath + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path string @@ -127430,19 +144595,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interfaces
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

+
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
-

returns l-interfaces

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -127488,32 +144658,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -127525,29 +144697,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -127570,17 +144719,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
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 l-interface

+

returns l3-interface-ipv6-address-list

@@ -127642,6 +144791,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
- prov-status + interface-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Name given to the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
prov-status @@ -127717,6 +144882,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -127743,7 +144953,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /l3-interface-ipv6-address-list
@@ -127771,17 +144981,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 l-interface

+

create or update an existing l3-interface-ipv6-address-list

@@ -127790,13 +145000,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /l-interface + /l3-interface-ipv6-address-list
@@ -127860,6 +145070,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -127891,23 +145117,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

delete an existing l-interface

+

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 +
+
+
@@ -127970,12 +145208,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -128015,19 +145253,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns l3-interface-ipv4-address-list

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -128089,7 +145332,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -128232,29 +145371,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -128277,17 +145393,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -128296,13 +145412,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

- /l3-interface-ipv4-address-list + /relationship
@@ -128368,7 +145484,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -128105,115 +145348,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

 query @@ -128221,6 +145359,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -128413,17 +145529,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv4-address-list

+

delete an existing relationship

@@ -128492,7 +145608,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -128506,22 +145622,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -128553,11 +145653,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
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

+

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
@@ -128572,7 +145672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterface.json)

@@ -128642,12 +145742,104 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
- l3-interface-ipv4-address + equipment-name -

IP address

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

 path @@ -128689,24 +145881,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

delete an existing relationship

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -128768,18 +145955,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -128791,6 +146037,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
default @@ -128813,17 +146082,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv6-address-list

+

returns sriov-vf

@@ -128887,10 +146156,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + +
- l3-interface-ipv4-address + prov-status -

IP address

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery + 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 -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -128978,14 +146247,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vf-vlan-filter -

Inner VLAN tag

+

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

 query - integer + string @@ -128993,10 +146262,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + vf-mac-filter -

Neutron network id of the interface that address belongs to

+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query @@ -129008,10 +146277,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + vf-vlan-strip -

Neutron id of subnet that address belongs to

+

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 @@ -129047,7 +146331,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /sriov-vf
@@ -129075,17 +146359,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 l3-interface-ipv6-address-list

+

create or update an existing sriov-vf

@@ -129094,13 +146378,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

- /l3-interface-ipv6-address-list + /sriov-vf
@@ -129166,10 +146450,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -129211,23 +146495,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing sriov-vf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -129290,10 +146586,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv6-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -129304,22 +146600,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -129351,35 +146631,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

see node definition for valid relationships

+

delete an existing sriov-vf

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -129442,118 +146710,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- 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 + pci-id -

Name given to the interface

+

PCI ID used to identify the sriov-vf

 path @@ -129566,12 +146726,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -129611,11 +146771,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -129630,7 +146790,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -129700,6 +146860,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -129731,11 +146907,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
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

+

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
@@ -129808,6 +146984,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string + + + +
@@ -129839,17 +147031,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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 sriov-vfs

+

returns vlans

@@ -130012,7 +147204,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /vlans
@@ -130040,17 +147232,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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 sriov-vf

+

returns vlan

@@ -130114,10 +147306,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -130205,14 +147397,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + vlan-id-inner -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Inner VLAN tag

 query - string + integer @@ -130220,10 +147412,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + vpn-key -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

This indicates the customers VPN ID associated with this vlan

 query @@ -130233,34 +147425,163 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + Network +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + - + - + + + + + + + + + + + + + + + @@ -130272,29 +147593,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -130317,17 +147615,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing vlan
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: Network
-

create or update an existing sriov-vf

+

update an existing vlan

@@ -130336,13 +147634,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated

+

vlan object that needs to be created or updated.

- /sriov-vf + /vlan
@@ -130408,10 +147706,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + equipment-name -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

querypath - boolean + string +
- neutron-network-id + interface-name -

Neutron network id of the interface

+

Name that identifies the physical interface

querypath + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path string +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -130453,17 +147751,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 sriov-vf

+

delete an existing vlan

@@ -130532,10 +147830,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

 path @@ -130593,36 +147891,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

see node definition for valid relationships

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -130684,10 +147965,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -130698,6 +147995,156 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 + + +
@@ -130707,6 +148154,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l3-interface-ipv4-address-list +
+
+
+ +
default @@ -130729,23 +148199,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
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
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -130808,10 +148290,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

 path @@ -130853,19 +148351,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

+
update an existing l3-interface-ipv4-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns vlans

+

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 +
+
+
+
@@ -130927,77 +148442,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - + - + @@ -131009,29 +148481,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -131054,19 +148503,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns vlan

+

delete an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
- 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 + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
- network-name + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
@@ -131144,25 +148598,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

IP address

querypath string +
- prov-status + resource-version -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

resource-version for concurrency

 query @@ -131170,81 +148625,159 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + - + @@ -131256,29 +148789,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -131301,35 +148811,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing vlan

+

delete an existing relationship

application/json application/xml

-
-
-

vlan object that needs to be created or updated

-

-
-
-
-
- /vlan -
-
-
- interface-id + equipment-name -

ID of interface

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the physical interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vlan-id-inner + vlan-interface -

Inner VLAN tag

+

String that identifies the interface

querypath - integer + string +
- vpn-key + l3-interface-ipv4-address -

This indicates the customers VPN ID associated with this vlan

+

IP address

querypath string +
@@ -131406,6 +148904,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
@@ -131437,24 +148951,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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
-

delete an existing vlan

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
@@ -131532,12 +149041,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- resource-version + l3-interface-ipv6-address -

resource-version for concurrency

+

IP address

querypath string @@ -131546,151 +149055,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + prov-status +

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- interface-name + prov-status -

Name that identifies the physical interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- interface-name + interface-id -

Name given to the interface

+

ID of interface

pathquery string -
- vlan-interface + macaddr -

String that identifies the interface

+

MAC address for the interface

pathquery string -
- l3-interface-ipv4-address + network-name -

IP address

+

Name of the network

pathquery string -
- prov-status + vlan-id-inner -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

Inner VLAN tag

 query - string + integer @@ -131698,10 +149147,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vpn-key -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

This indicates the customers VPN ID associated with this vlan

 query @@ -131713,14 +149162,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vlan-id-inner -

ID of interface

+

Inner VLAN tag

 query - string + integer @@ -131728,10 +149177,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + neutron-network-id -

MAC address for the interface

+

Neutron network id of the interface that address belongs to

 query @@ -131743,10 +149192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-subnet-id -

Name of the network

+

Neutron id of subnet that address belongs to

 query @@ -131756,79 +149205,179 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + - + @@ -131840,29 +149389,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv4-address-list -
-
-
- -
default @@ -131885,17 +149411,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

update an existing l3-interface-ipv6-address-list

@@ -131904,13 +149430,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated.

- /l3-interface-ipv4-address-list + /l3-interface-ipv6-address-list
@@ -131992,7 +149518,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- vlan-id-inner + equipment-name -

Inner VLAN tag

querypath - integer + string +
- vpn-key + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the physical interface

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name given to the interface

querypath - integer + string +
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -132037,17 +149563,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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-ipv4-address-list

+

delete an existing l3-interface-ipv6-address-list

@@ -132132,7 +149658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -132193,11 +149719,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -132212,7 +149738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -132300,7 +149826,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -132345,11 +149871,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -132440,7 +149966,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + l3-interface-ipv6-address

IP address

@@ -132485,19 +150011,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /relationship +
+
+
+
@@ -132573,12 +150116,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - + - + - + + +
- l3-interface-ipv6-address + equipment-name -

IP address

 path @@ -132591,152 +150194,246 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status - -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

- 		query - string - - -
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name that identifies the physical interface

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + vlan-interface -

MAC address for the interface

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterface.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - - - - - - - - + + +
- network-name + equipment-name -

Name of the network

querypath string +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the physical interface

querypath 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 +

+
+
+ + + + + + + + + + + - - - - - - - - + - + @@ -132748,29 +150445,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-interface-ipv6-address-list -
-
-
- -
default @@ -132793,36 +150467,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
returns sriov-pfs
+

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

Tags: Network
-

create or update an existing l3-interface-ipv6-address-list

+

returns sriov-pfs

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + equipment-name -

Neutron network id of the interface that address belongs to

querypath string +
- neutron-subnet-id + interface-name -

Neutron id of subnet that address belongs to

+

Name that identifies the physical interface

querypath string +
@@ -132868,50 +150525,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -132923,6 +150562,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
default @@ -132945,24 +150607,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

delete an existing l3-interface-ipv6-address-list

+

returns sriov-pf

-
- -

application/json application/xml -

-
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + prov-status -

String that identifies the interface

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- l3-interface-ipv6-address + prov-status -

IP address

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
@@ -133008,26 +150665,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -133079,6 +150718,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
default @@ -133101,17 +150763,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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
-

see node definition for valid relationships

+

create or update an existing sriov-pf

@@ -133120,13 +150782,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

sriov-pf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

- /relationship + /sriov-pf
@@ -133176,10 +150838,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + pf-pci-id -

String that identifies the interface

+

Identifier for the sriov-pf

 path @@ -133040,26 +150681,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + prov-status -

IP address

+

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

pathquery string -
- resource-version + prov-status -

resource-version for concurrency

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -133067,7 +150707,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- interface-name + pf-pci-id -

Name given to the interface

+

Identifier for the sriov-pf

 path @@ -133190,12 +150852,84 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-pf
+

PATCH /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + Network +
+
+
+

update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated.

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + equipment-name -

String that identifies the interface

 path @@ -133208,10 +150942,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + interface-name -

IP address

+

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

 path @@ -133253,17 +151003,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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 relationship

+

delete an existing sriov-pf

@@ -133316,26 +151066,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + pf-pci-id -

String that identifies the interface

+

Identifier for the sriov-pf

 path @@ -133348,12 +151082,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -133393,11 +151127,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -133412,7 +151146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPePInterfacesPInterfaceSriovPfsSriovPf.json)

@@ -133468,26 +151202,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + pf-pci-id -

String that identifies the interface

+

Identifier for the sriov-pf

 path @@ -133529,11 +151247,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

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
@@ -133592,26 +151310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

- 		path - string - - - -
- vlan-interface + pf-pci-id -

String that identifies the interface

+

Identifier for the sriov-pf

 path @@ -133653,11 +151355,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network
@@ -133672,7 +151374,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVplsPesVplsPe.json)

@@ -133710,22 +151412,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
@@ -133757,11 +151443,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

+

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Tags: Network
@@ -133802,22 +151488,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
@@ -133849,95 +151519,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-pfs
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+
returns vpn-bindings
+

GET /network/vpn-bindings

Tags: Network
-

returns sriov-pfs

+

returns vpn-bindings

-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 @@ -133961,7 +151555,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /sriov-pfs + /vpn-bindings
@@ -133989,17 +151583,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-pf
-

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+
returns vpn-binding
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

returns sriov-pf

+

returns vpn-binding

@@ -134016,41 +151610,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- pf-pci-id + vpn-id -

Identifier for the sriov-pf

+

VPN ID, globally unique within A&AI

 path @@ -134063,10 +151626,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vpn-name -

Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

+

VPN Name

 query @@ -134078,10 +151641,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vpn-type -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Type of the vpn, should be taken from enumerated/valid values

 query @@ -134117,7 +151680,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-pf + /vpn-binding
@@ -134145,17 +151708,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing vpn-binding
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

create or update an existing sriov-pf

+

create or update an existing vpn-binding

@@ -134164,13 +151727,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-pf object that needs to be created or updated

+

vpn-binding object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)

- /sriov-pf + /vpn-binding
@@ -134189,41 +151752,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- pf-pci-id + vpn-id -

Identifier for the sriov-pf

+

VPN ID, globally unique within A&AI

 path @@ -134265,23 +151797,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
update an existing vpn-binding
+

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

delete an existing sriov-pf

+

update an existing vpn-binding

application/json application/xml

+
+
+

vpn-binding object that needs to be created or updated.

+

+
+
+
+
+ /vpn-binding +
+
+
@@ -134297,41 +151841,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- pf-pci-id + vpn-id -

Identifier for the sriov-pf

+

VPN ID, globally unique within A&AI

 path @@ -134342,22 +151855,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -134389,35 +151886,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
delete an existing vpn-binding
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

Tags: Network
-

see node definition for valid relationships

+

delete an existing vpn-binding

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -134433,25 +151918,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - +
- equipment-name - - path - string - - - -
- interface-name + vpn-id -

Name that identifies the physical interface

+

VPN ID, globally unique within A&AI

 path @@ -134464,12 +151934,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pf-pci-id + resource-version -

Identifier for the sriov-pf

+

resource-version for concurrency

pathquery string @@ -134509,23 +151979,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
see node definition for valid relationships
+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBinding.json)

+

+
+
+
+
+ /relationship +
+
+
@@ -134541,41 +152023,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- equipment-name - - path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- pf-pci-id + vpn-id -

Identifier for the sriov-pf

+

VPN ID, globally unique within A&AI

 path @@ -134617,35 +152068,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+
delete an existing relationship
+

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Tags: Network
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -134661,9 +152100,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + - -
- equipment-name + vpn-id +

VPN ID, globally unique within A&AI

 path @@ -134705,24 +152145,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

+
returns route-targets
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

Tags: Network
-

delete an existing relationship

+

returns route-targets

-
- -

application/json application/xml -

-
@@ -134737,9 +152172,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- equipment-name + vpn-id +

VPN ID, globally unique within A&AI

 path @@ -134750,6 +152186,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vpn-name + +

VPN Name

+ 		query + string + + +
+ vpn-type + +

Type of the vpn, should be taken from enumerated/valid values

+ 		query + string + + +
@@ -134759,6 +152225,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /route-targets +
+
+
+ +
default @@ -134781,19 +152270,112 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vpn-bindings
-

GET /network/vpn-bindings

+
returns route-target
+

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network
-

returns vpn-bindings

+

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 @@ -134817,7 +152399,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /vpn-bindings + /route-target
@@ -134845,19 +152427,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vpn-binding
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}

+
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
-

returns vpn-binding

+

create or update an existing route-target

+
+ +

application/json application/xml +

+
+
+

route-target object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

+

+
+
+
+
+ /route-target +
+
+
+
@@ -134888,32 +152487,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -134925,29 +152526,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vpn-binding -
-
-
- -
default @@ -134970,17 +152548,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vpn-binding
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

+
update an existing route-target
+

PATCH /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

Tags: Network
-

create or update an existing vpn-binding

+

update an existing route-target

@@ -134989,13 +152567,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vpn-binding object that needs to be created or updated

+

route-target object that needs to be created or updated.

- /vpn-binding + /route-target
@@ -135028,6 +152606,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + +
- vpn-name + global-route-target -

VPN Name

+

Number used to identify an RT, globally unique in the network

querypath string +
- vpn-type + route-target-role -

Type of the vpn, should be taken from enumerated/valid values

+

Role assigned to this route target

querypath 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 + + + +
@@ -135059,17 +152669,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vpn-binding
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

+
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 vpn-binding

+

delete an existing route-target

@@ -135105,6 +152715,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ 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 @@ -135152,11 +152794,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

+

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Tags: Network
@@ -135171,7 +152813,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkVpnBindingsVpnBindingRouteTargetsRouteTarget.json)

@@ -135210,73 +152852,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 + global-route-target -

VPN ID, globally unique within A&AI

+

Number used to identify an RT, globally unique in the network

+ 		path + string + + + +
+ route-target-role + +

Role assigned to this route target

 path @@ -135318,19 +152915,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns route-targets
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

+
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
-

returns route-targets

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -135361,38 +152963,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - +
- vpn-name + global-route-target -

VPN Name

+

Number used to identify an RT, globally unique in the network

querypath string +
- vpn-type + route-target-role -

Type of the vpn, should be taken from enumerated/valid values

+

Role assigned to this route target

querypath 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

@@ -135415,7 +153060,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-targets + /zones
@@ -135443,17 +153088,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns route-target
-

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+
returns zone
+

GET /network/zones/zone/{zone-id}

Tags: Network
-

returns route-target

+

returns zone

@@ -135470,42 +153115,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + zone-id -

Role assigned to this route target

+

Code assigned by AIC to the zone

 path @@ -135518,10 +153131,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-name + design-type -

VPN Name

+

Design of zone [Medium/Large?]

 query @@ -135533,10 +153146,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-type + zone-context -

Type of the vpn, should be taken from enumerated/valid values

+

Context of zone [production/test]

 query @@ -135572,7 +153185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /route-target + /zone
@@ -135600,17 +153213,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
create or update an existing zone
+

PUT /network/zones/zone/{zone-id}

Tags: Network
-

create or update an existing route-target

+

create or update an existing zone

@@ -135619,13 +153232,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

route-target object that needs to be created or updated

+

zone object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)

- /route-target + /zone
@@ -135644,42 +153257,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + zone-id -

Role assigned to this route target

+

Code assigned by AIC to the zone

 path @@ -135721,23 +153302,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing route-target
-

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}

+
update an existing zone
+

PATCH /network/zones/zone/{zone-id}

Tags: Network
-

delete an existing route-target

+

update an existing zone

application/json application/xml

+
+
+

zone object that needs to be created or updated.

+

+
+
+
+
+ /zone +
+
+
@@ -135753,26 +153346,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - + +
- vpn-id - -

VPN ID, globally unique within A&AI

- 		path - string - - - -
- global-route-target + zone-id -

Number used to identify an RT, globally unique in the network

+

Code assigned by AIC to the zone

 path @@ -135783,12 +153360,73 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- route-target-role + zone-id -

Role assigned to this route target

+

Code assigned by AIC to the zone

 path @@ -135846,11 +153484,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

Tags: Network
@@ -135865,7 +153503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/NetworkZonesZone.json)

@@ -135890,42 +153528,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + zone-id -

Role assigned to this route target

+

Code assigned by AIC to the zone

 path @@ -135967,11 +153573,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
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

+

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

Tags: Network
@@ -135999,42 +153605,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + zone-id -

Role assigned to this route target

+

Code assigned by AIC to the zone

 path @@ -136076,17 +153650,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns zones
-

GET /network/zones

+
returns models
+

GET /service-design-and-creation/models

Tags: - Network + ServiceDesignAndCreation
-

returns zones

+

returns models

@@ -136112,7 +153686,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /zones + /models
@@ -136140,17 +153714,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns zone
-

GET /network/zones/zone/{zone-id}

+
returns model
+

GET /service-design-and-creation/models/model/{model-invariant-id}

Tags: - Network + ServiceDesignAndCreation
-

returns zone

+

returns model

@@ -136167,10 +153741,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- zone-id + model-invariant-id -

Code assigned by AIC to the zone

+

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -136183,25 +153757,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- design-type - -

Design of zone [Medium/Large?]

- 		query - string - - -
- zone-context + model-type -

Context of zone [production/test]

+

Type of the model, e.g., service, resource, widget, etc.

 query @@ -136237,7 +153796,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /zone + /model
@@ -136265,17 +153824,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing zone
-

PUT /network/zones/zone/{zone-id}

+
create or update an existing model
+

PUT /service-design-and-creation/models/model/{model-invariant-id}

Tags: - Network + ServiceDesignAndCreation
-

create or update an existing zone

+

create or update an existing model

@@ -136284,13 +153843,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

zone object that needs to be created or updated

+

model object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)

- /zone + /model
@@ -136309,10 +153868,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- zone-id + model-invariant-id -

Code assigned by AIC to the zone

+

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -136354,23 +153913,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing zone
-

DELETE /network/zones/zone/{zone-id}

+
update an existing model
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}

Tags: - Network + ServiceDesignAndCreation
-

delete an existing zone

+

update an existing model

application/json application/xml

+
+
+

model object that needs to be created or updated.

+

+
+
+
+
+ /model +
+
+
@@ -136386,10 +153957,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- zone-id + model-invariant-id -

Code assigned by AIC to the zone

+

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -136400,22 +153971,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -136447,35 +154002,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

+
delete an existing model
+

DELETE /service-design-and-creation/models/model/{model-invariant-id}

Tags: - Network + ServiceDesignAndCreation
-

see node definition for valid relationships

+

delete an existing model

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -136491,10 +154034,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- zone-id + model-invariant-id -

Code assigned by AIC to the zone

+

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -136505,6 +154048,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -136536,24 +154095,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing relationship
-

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

+
returns model-vers
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

Tags: - Network + ServiceDesignAndCreation
-

delete an existing relationship

+

returns model-vers

-
- -

application/json application/xml -

-
@@ -136568,10 +154122,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- zone-id + model-invariant-id -

Code assigned by AIC to the zone

+

Unique identifier corresponding to the main definition of a model in ASDC

 path @@ -136582,6 +154136,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ model-type + +

Type of the model, e.g., service, resource, widget, etc.

+ 		query + string + + +
@@ -136591,6 +154160,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /model-vers +
+
+
+ +
default @@ -136613,19 +154205,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns models
-

GET /service-design-and-creation/models

+
returns model-ver
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation
-

returns models

+

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 @@ -136649,7 +154333,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /models + /model-ver
@@ -136677,19 +154361,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns model
-

GET /service-design-and-creation/models/model/{model-invariant-id}

+
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
-

returns model

+

create or update an existing model-ver

+
+ +

application/json application/xml +

+
+
+

model-ver object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

+

+
+
+
+
+ /model-ver +
+
+
+
@@ -136720,17 +154421,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + @@ -136742,29 +154444,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model -
-
-
- -
default @@ -136787,17 +154466,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing model
-

PUT /service-design-and-creation/models/model/{model-invariant-id}

+
update an existing model-ver
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

Tags: ServiceDesignAndCreation
-

create or update an existing model

+

update an existing model-ver

@@ -136806,13 +154485,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model object that needs to be created or updated

+

model-ver object that needs to be created or updated.

- /model + /model-ver
@@ -136845,6 +154524,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- model-type + model-version-id -

Type of the model, e.g., service, resource, widget, etc.

+

Unique identifier corresponding to one version of a model in ASDC

querypath string +
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
@@ -136876,17 +154571,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing model
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}

+
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

+

delete an existing model-ver

@@ -136922,6 +154617,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
resource-version @@ -136969,17 +154680,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns model-vers
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

+
returns metadata
+

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

Tags: ServiceDesignAndCreation
-

returns model-vers

+

returns metadata

@@ -137010,6 +154721,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ model-version-id + +

Unique identifier corresponding to one version of a model in ASDC

+ 		path + string + + + +
model-type @@ -137025,6 +154752,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ model-name + +

Name of the model, which can change from version to version.

+ 		query + string + + +
+ model-version + +

Version

+ 		query + string + + +
@@ -137051,7 +154808,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /model-vers + /metadata
@@ -137079,17 +154836,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns model-ver
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+
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 model-ver

+

returns metadatum

@@ -137136,6 +154893,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ metaname + + path + string + + + +
model-type @@ -137207,7 +154979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /model-ver + /metadatum
@@ -137235,35 +155007,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
+
+
create or update an existing metadatum
+

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerMetadataMetadatum.json)

+

+
+
+
+
+ /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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing metadatum
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing metadatum

+ +
+
+ +

application/json application/xml +

+
+
+

metadatum object that needs to be created or updated.

+

+
+
+
+
+ /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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
-
create or update an existing model-ver
-

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}

+
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
-

create or update an existing model-ver

+

delete an existing metadatum

application/json application/xml

-
-
-

model-ver object that needs to be created or updated

-

-
-
-
-
- /model-ver -
-
-
@@ -137309,89 +155309,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

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 -

-
-
- - - - - - - - - - - - - - - - - - @@ -137748,7 +155670,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /model-element
@@ -137776,17 +155698,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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 metadatum

+

create or update an existing model-element

@@ -137795,13 +155717,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated

+

model-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

- /metadatum + /model-element
@@ -137852,7 +155774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -137896,23 +155818,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing metadatum
-

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+
update an existing model-element
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Tags: ServiceDesignAndCreation
-

delete an existing metadatum

+

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 + metaname -

Unique identifier corresponding to one version of a model in ASDC

 path @@ -137449,17 +155371,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns metadata
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

+
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 metadata

+

returns model-elements

@@ -137577,7 +155499,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadata + /model-elements
@@ -137605,17 +155527,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns metadatum
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata/metadatum/{metaname}

+
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 metadatum

+

returns model-element

@@ -137664,7 +155586,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- metaname + model-element-uuid
- metaname + model-element-uuid
@@ -137960,7 +155894,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- metaname + 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 +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -138020,17 +156062,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns model-elements
-

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

+
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-elements

+

returns model-constraints

@@ -138077,6 +156119,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + - -
+ 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
+ model-element-uuid + + path + string + + + +
model-type @@ -138148,7 +156205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /model-elements + /model-constraints
@@ -138176,17 +156233,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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-element

+

returns model-constraint

@@ -138248,6 +156305,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ model-constraint-uuid + + path + string + + + +
model-type @@ -138319,7 +156391,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /model-element + /model-constraint
@@ -138347,17 +156419,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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-element

+

create or update an existing model-constraint

@@ -138366,13 +156438,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

model-element object that needs to be created or updated

+

model-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraint.json)

- /model-element + /model-constraint
@@ -138436,102 +156508,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - @@ -138544,22 +156523,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- 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 + model-constraint-uuid
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -138591,19 +156554,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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

+
update an existing model-constraint
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Tags: ServiceDesignAndCreation
-

returns model-constraints

+

update an existing model-constraint

+
+ +

application/json application/xml +

+
+
+

model-constraint object that needs to be created or updated.

+

+
+
+
+
+ /model-constraint +
+
+
+
@@ -138665,47 +156645,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -138717,29 +156667,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-constraints -
-
-
- -
default @@ -138763,18 +156690,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
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}

+
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
-

returns model-constraint

+

delete an existing model-constraint

+
+ +

application/json application/xml +

+
- 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 + model-constraint-uuid -

Version

querypath string +
@@ -138851,40 +156783,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - @@ -138903,29 +156806,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /model-constraint -
-
-
- -
default @@ -138948,36 +156828,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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}

+
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
-

create or update an existing model-constraint

+

returns constrained-element-sets

-
- -

application/json application/xml -

-
-
-

model-constraint object that needs to be created or updated

-

-
-
-
-
- /model-constraint -
-
-
-
- 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 + resource-version -

Version

+

resource-version for concurrency

 query @@ -138892,6 +156794,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -139052,135 +156915,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
- -
-

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 -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - + - + @@ -139200,6 +156969,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /constrained-element-sets +
+
+
+ +
default @@ -139222,17 +157014,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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-sets

+

returns constrained-element-set

@@ -139309,6 +157101,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + - - - - - - - + + + + + + + + +
- 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 + model-type +

Type of the model, e.g., service, resource, widget, etc.

pathquery string -
- model-constraint-uuid + model-name +

Name of the model, which can change from version to version.

pathquery string -
- resource-version + model-version -

resource-version for concurrency

+

Version

 query @@ -139188,7 +156958,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+ constrained-element-set-uuid + + path + string + + + +
model-type @@ -139380,7 +157187,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /constrained-element-sets + /constrained-element-set
@@ -139409,18 +157216,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
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}

+
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
-

returns constrained-element-set

+

create or update an existing constrained-element-set

+
+ +

application/json application/xml +

+
+
+

constrained-element-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

+

+
+
+
+
+ /constrained-element-set +
+
+
+
@@ -139510,49 +157334,154 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing constrained-element-set
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing constrained-element-set

+ +
+
+ +

application/json application/xml +

+
+
+

constrained-element-set object that needs to be created or updated.

+

+
+
+
+
+ /constrained-element-set +
+
+
+
+
+ + + + + + + + + + + - + - + - + + + + + + + + + + + + + + + @@ -139564,29 +157493,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /constrained-element-set -
-
-
- -
default @@ -139610,34 +157516,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
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}

+
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
-

create or update an existing constrained-element-set

+

delete an existing constrained-element-set

application/json application/xml

-
-
-

constrained-element-set object that needs to be created or updated

-

-
-
-
-
- /constrained-element-set -
-
-
- model-type + model-invariant-id -

Type of the model, e.g., service, resource, widget, etc.

+

Unique identifier corresponding to the main definition of a model in ASDC

querypath string +
- model-name + model-version-id -

Name of the model, which can change from version to version.

+

Unique identifier corresponding to one version of a model in ASDC

querypath string +
- model-version + model-element-uuid -

Version

querypath + string + + + +
+ model-constraint-uuid + + path + string + + + +
+ constrained-element-set-uuid + + path string +
@@ -139728,6 +157622,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -139759,24 +157669,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
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
-

delete an existing constrained-element-set

+

returns element-choice-sets

-
- -

application/json application/xml -

-
@@ -139868,10 +157773,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + @@ -139891,6 +157825,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /element-choice-sets +
+
+
+ +
default @@ -139913,17 +157870,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
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

+
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-sets

+

returns element-choice-set

@@ -140015,6 +157972,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + - - - - - - - + + + + + + + + +
- resource-version + model-type -

resource-version for concurrency

+

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 @@ -139879,7 +157814,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+ element-choice-set-uuid + + path + string + + + +
model-type @@ -140086,7 +158058,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /element-choice-sets + /element-choice-set
@@ -140115,18 +158087,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
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}

+
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
-

returns element-choice-set

+

create or update an existing element-choice-set

+
+ +

application/json application/xml +

+
+
+

element-choice-set object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

+

+
+
+
+
+ /element-choice-set +
+
+
+
@@ -140231,51 +158220,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- 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 - - -
@@ -140285,29 +158229,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /element-choice-set -
-
-
- -
default @@ -140331,16 +158252,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

+
update an existing element-choice-set
+

PATCH /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Tags: ServiceDesignAndCreation
-

create or update an existing element-choice-set

+

update an existing element-choice-set

@@ -140349,13 +158270,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

element-choice-set object that needs to be created or updated

+

element-choice-set object that needs to be created or updated.

- /element-choice-set + /element-choice-set
@@ -140683,7 +158604,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSetElementChoiceSetsElementChoiceSet.json)

@@ -141001,7 +158922,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElementModelConstraintsModelConstraintConstrainedElementSetsConstrainedElementSet.json)

@@ -141289,7 +159210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVerModelElementsModelElement.json)

@@ -141517,7 +159438,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModelModelVersModelVer.json)

@@ -141715,7 +159636,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationModelsModel.json)

@@ -141898,7 +159819,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /named-queries + /named-queries
@@ -142006,7 +159927,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /named-query + /named-query
@@ -142053,7 +159974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

named-query object that needs to be created or updated

+

named-query object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

@@ -142122,6 +160043,94 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing named-query
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing named-query

+ +
+
+ +

application/json application/xml +

+
+
+

named-query object that needs to be created or updated.

+

+
+
+
+
+ /named-query +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -142294,7 +160303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /named-query-elements + /named-query-elements
@@ -142417,7 +160426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /named-query-element + /named-query-element
@@ -142464,7 +160473,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

named-query-element object that needs to be created or updated

+

named-query-element object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

@@ -142548,6 +160557,109 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing named-query-element
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing named-query-element

+ +
+
+ +

application/json application/xml +

+
+
+

named-query-element object that needs to be created or updated.

+

+
+
+
+
+ /named-query-element +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -142750,7 +160862,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /property-constraints + /property-constraints
@@ -142888,7 +161000,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /property-constraint + /property-constraint
@@ -142935,7 +161047,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

property-constraint object that needs to be created or updated

+

property-constraint object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementPropertyConstraintsPropertyConstraint.json)

@@ -143034,6 +161146,124 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing property-constraint
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing property-constraint

+ +
+
+ +

application/json application/xml +

+
+
+

property-constraint object that needs to be created or updated.

+

+
+
+
+
+ /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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -143251,7 +161481,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /related-lookups + /related-lookups
@@ -143349,20 +161579,161 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- named-query-name - - query - 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. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)

+

+
+
+
+
+ /related-lookup +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ named-query-uuid + + path + string + + + +
+ named-query-element-uuid + + path + string + + + +
+ related-lookup-uuid + + path + string + + + +
@@ -143372,29 +161743,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /related-lookup -
-
-
- -
default @@ -143418,16 +161766,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
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}

+
update an existing related-lookup
+

PATCH /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/related-lookups/related-lookup/{related-lookup-uuid}

Tags: ServiceDesignAndCreation
-

create or update an existing related-lookup

+

update an existing related-lookup

@@ -143436,13 +161784,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

related-lookup object that needs to be created or updated

+

related-lookup object that needs to be created or updated.

- /related-lookup + /related-lookup
@@ -143676,7 +162024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElementRelatedLookupsRelatedLookup.json)

@@ -143900,7 +162248,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQueryNamedQueryElementsNamedQueryElement.json)

@@ -144094,7 +162442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationNamedQueriesNamedQuery.json)

@@ -144275,7 +162623,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /service-capabilities + /service-capabilities
@@ -144386,7 +162734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /service-capability + /service-capability
@@ -144433,7 +162781,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service-capability object that needs to be created or updated

+

service-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

@@ -144519,6 +162867,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing service-capability
+

PATCH /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing service-capability

+ +
+
+ +

application/json application/xml +

+
+
+

service-capability object that needs to be created or updated.

+

+
+
+
+
+ /service-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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -144647,7 +163100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServiceCapabilitiesServiceCapability.json)

@@ -144862,7 +163315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /services + /services
@@ -144931,21 +163384,133 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-description - -

Description of the service

- 		query - string - - -
+ service-description + +

Description of the service

+ 		query + string + + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /service +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing service
+

PUT /service-design-and-creation/services/service/{service-id}

+ Tags: + ServiceDesignAndCreation +
+
+
+

create or update an existing service

+ +
+
+ +

application/json application/xml +

+
+
+

service object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)

+

+
+
+
+
+ /service +
+
+
+
+
+ + + + + + + + + + + + + + + + + +
+ service-id + +

This gets defined by others to provide a unique ID for the service, we accept what is sent.

+ 		path + string + + + +
@@ -144955,29 +163520,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /service -
-
-
- -
default @@ -145001,16 +163543,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
create or update an existing service
-

PUT /service-design-and-creation/services/service/{service-id}

+
update an existing service
+

PATCH /service-design-and-creation/services/service/{service-id}

Tags: ServiceDesignAndCreation
-

create or update an existing service

+

update an existing service

@@ -145019,13 +163561,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

service object that needs to be created or updated

+

service object that needs to be created or updated.

- /service + /service
@@ -145201,7 +163743,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationServicesService.json)

@@ -145384,7 +163926,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vnf-images + /vnf-images
@@ -145524,7 +164066,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vnf-image + /vnf-image
@@ -145571,7 +164113,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vnf-image object that needs to be created or updated

+

vnf-image object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)

@@ -145641,6 +164183,95 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+
+
update an existing vnf-image
+

PATCH /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}

+ Tags: + ServiceDesignAndCreation +
+
+
+

update an existing vnf-image

+ +
+
+ +

application/json application/xml +

+
+
+

vnf-image object that needs to be created or updated.

+

+
+
+
+
+ /vnf-image +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+
@@ -145733,176 +164364,215 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - -
-
-
see node definition for valid relationships
-

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

- Tags: - ServiceDesignAndCreation -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- vnf-image-uuid - -

Unique ID of this asset

- 		path - string - - - -
-
+ + +
+
+
see node definition for valid relationships
+

PUT /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v11/ServiceDesignAndCreationVnfImagesVnfImage.json)

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

+ Tags: + ServiceDesignAndCreation +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-image-uuid + +

Unique ID of this asset

+ 		path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +

Schema definitions

+ +
+
+

aai-internal: + object + + + +

+
+
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
+
+
+
+ property-name: + string + -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /service-design-and-creation/vnf-images/vnf-image/{vnf-image-uuid}/relationship-list/relationship

- Tags: - ServiceDesignAndCreation -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- vnf-image-uuid - -

Unique ID of this asset

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- + +
+
+
-
-
+ +
+ property-value: + string + -
-
- -
- - + +
+
+ +
+
+ + +
-
- - -

Schema definitions

-

action: @@ -146065,19 +164735,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

Represents a slice or partial piece of a resource that gets separately allotted

    -
  • 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)
    • -
  • TO allotted-resource (One2One)
    • -
  • FROM configuration
    • -
  • FROM service-instance (is composed of allotted-resource)
    • -
  • FROM service-instance
    • -
  • FROM allotted-resource
+
  • TO allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
    • +
  • TO generic-vnf( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • TO instance-group( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO l3-network( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • TO l-interface( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
    • +
  • TO network-policy( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
    • +
  • TO vlan( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
    • +
  • TO vpn-binding( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
    • +
  • TO service-instance( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM tunnel-xconnect( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    • +
  • FROM configuration( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource tosca.relationships.network.BindsTo allotted-resource, ONE2ONE)
    • +
  • ALLOTTED-RESOURCE is DELETED when these are DELETED TUNNEL-XCONNECT
    • @@ -146315,14 +164986,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Availability zone, a collection of compute hosts/pservers

      -
    • 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
    +
  • TO complex( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO service-capability( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • +
  • TO cloud-region( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM ctag-pool( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • +
  • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
    • +
  • FROM vce( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • AVAILABILITY-ZONE cannot be deleted if linked to CTAG-POOL,DVS-SWITCH,GENERIC-VNF,PSERVER,VCE
    • @@ -146654,7 +165326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM site-pair (is composed of class-of-service)
    +
  • TO site-pair( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
    • @@ -146909,21 +165581,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    cloud-region designates an installation of a cloud cluster or region or instantiation.

      -
    • TO esr-system-info (comprises cloud-region, One2Many)
      • -
    • 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
    +
  • TO esr-system-info (CHILD of cloud-region, cloud-region has esr-system-info, One2Many)
    • +
  • TO complex( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO l3-network( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO zone( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM dvs-switch( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM flavor( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM group-assignment( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM image( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM snapshot( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
    • +
  • CLOUD-REGION cannot be deleted if linked to DVS-SWITCH,FLAVOR,GROUP-ASSIGNMENT,IMAGE,OAM-NETWORK,SNAPSHOT,TENANT,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST,VOLUME-GROUP
    • +
  • CLOUD-REGION is DELETED when these are DELETED AVAILABILITY-ZONE
    • +
  • CLOUD-REGION deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    • @@ -147292,6 +165969,46 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    + +
    + vip-ipv4-address-list: + object[] + + +
    +
    + +
    + +
    + vip-ipv4-address-list + + + +
    + +
    +
    +
    +
    + vip-ipv6-address-list: + object[] + + +
    +
    + +
    + +
    + vip-ipv6-address-list + + + +
    +
    @@ -147350,18 +166067,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical locations that can house cloud-regions.

      -
    • 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 vpls-pe
      • -
    • FROM volume-group
      • -
    • FROM zone
      • -
    • FROM generic-vnf
    +
  • TO l3-network( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM ctag-pool( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM vce( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • FROM volume-group( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM zone( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • COMPLEX cannot be deleted if linked to AVAILABILITY-ZONE,CLOUD-REGION,GENERIC-VNF,OAM-NETWORK,PNF,PSERVER,VCE,VOLUME-GROUP,VPLS-PE,ZONE
    • +
  • COMPLEX is DELETED when these are DELETED CTAG-POOL
    • @@ -147666,37 +166385,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Port Mirror Configuration.

      -
    • TO logical-link (One2Many)
      • -
    • TO metadatum (comprises configuration, One2Many)
      • -
    • TO allotted-resource (One2One)
      • -
    • FROM service-instance
      • -
    • FROM generic-vnf
    +
  • TO allotted-resource( configuration org.onap.relationships.inventory.Uses allotted-resource, ONE2ONE)
    • +
  • TO logical-link( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • CONFIGURATION is DELETED when these are DELETED METADATUM
    • +
  • CONFIGURATION deletion means associated objects of these types are also DELETED:ALLOTTED-RESOURCE,LOGICAL-LINK
    • -
    - management-option: +
    + configuration-id: string +
    -

    Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

    +

    UUID assigned to configuration.

    -
    - configuration-id: +
    + management-option: string -
    -

    UUID assigned to configuration.

    +

    Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.

    @@ -147829,7 +166550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object + object[]
    @@ -147838,7 +166559,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship-list + relationship @@ -147849,7 +166570,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    metadata: - object + object[]
    @@ -147858,7 +166579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - metadata + metadatum @@ -147926,9 +166647,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of resource instances used to connect a variety of disparate inventory widgets

      -
    • TO virtual-data-center (Many2Many)
      • -
    • TO metadatum (comprises connector, Many2Many)
      • -
    • FROM service-instance
    +
  • TO virtual-data-center( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
    • +
  • CONNECTOR is DELETED when these are DELETED METADATUM
    • @@ -148118,9 +166840,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • 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)
    +
  • TO model-constraint( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
    • +
  • TO model-element( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • +
  • FROM element-choice-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
    • +
  • CONSTRAINED-ELEMENT-SET is DELETED when these are DELETED ELEMENT-CHOICE-SET
    • @@ -148267,8 +166990,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM l3-network (is composed of ctag-assignment)
      • -
    • FROM service-instance
    +
  • TO l3-network( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    • @@ -148374,10 +167097,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    A collection of C tags (vlan tags) grouped for a specific purpose.

      -
    • TO availability-zone (Many2Many)
      • -
    • FROM complex (is composed of ctag-pool)
      • -
    • FROM vpls-pe
      • -
    • FROM generic-vnf
    +
  • TO complex( ctag-pool org.onap.relationships.inventory.BelongsTo complex, MANY2ONE)
    • +
  • TO availability-zone( ctag-pool org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • +
  • FROM vpls-pe( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • @@ -148521,7 +167244,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    customer identifiers to provide linkage back to BSS information.

      -
    • TO service-subscription (comprises customer, Many2Many)
    +
  • FROM service-subscription( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
    • +
  • CUSTOMER is DELETED when these are DELETED SERVICE-SUBSCRIPTION
    • @@ -148776,8 +167500,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.

      -
    • TO availability-zone (Many2Many)
      • -
    • FROM cloud-region (is composed of dvs-switch)
    +
  • TO cloud-region( dvs-switch org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • TO availability-zone( dvs-switch org.onap.relationships.inventory.AppliesTo availability-zone, MANY2MANY)
    • @@ -149145,8 +167869,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO model-element (comprises element-choice-set, One2Many)
      • -
    • FROM constrained-element-set (is composed of element-choice-set)
    +
  • TO constrained-element-set( element-choice-set org.onap.relationships.inventory.BelongsTo constrained-element-set, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
    • +
  • ELEMENT-CHOICE-SET is DELETED when these are DELETED MODEL-ELEMENT
    • @@ -149293,8 +168018,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for entitlement group.

      -
    • FROM generic-vnf (is composed of entitlement)
      • -
    • FROM vce (is composed of entitlement)
    +
  • TO generic-vnf( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO vce( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • @@ -149417,7 +168142,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist EMS address information used by EMS driver.

      -
    • TO esr-system-info (comprises esr-ems, One2Many)
    +
  • TO esr-system-info (CHILD of esr-ems, esr-ems has esr-system-info, One2Many)
    • +
  • ESR-EMS deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    • @@ -149450,7 +168176,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-system-info-list: - object[] + object
    @@ -149459,7 +168185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info + esr-system-info-list @@ -149470,7 +168196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -149479,7 +168205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -149543,10 +168269,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist common address information of external systems.

      -
    • FROM esr-ems (is composed of esr-system-info)
      • -
    • FROM esr-vnfm (is composed of esr-system-info)
      • -
    • FROM esr-thirdparty-sdnc (is composed of esr-system-info)
      • -
    • FROM cloud-region (is composed of esr-system-info)
    +
  • FROM esr-ems (PARENT of esr-system-info, esr-ems has esr-system-info)
    • +
  • FROM esr-vnfm (PARENT of esr-system-info, esr-vnfm has esr-system-info)
    • +
  • FROM esr-thirdparty-sdnc (PARENT of esr-system-info, esr-thirdparty-sdnc has esr-system-info)
    • +
  • FROM cloud-region (PARENT of esr-system-info, cloud-region has esr-system-info)
    • @@ -149875,8 +168601,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist SDNC address information used by ONAP SDNC.

      -
    • TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
      • -
    • TO pnf (One2Many)
    +
  • TO esr-system-info (CHILD of esr-thirdparty-sdnc, esr-thirdparty-sdnc has esr-system-info, One2One)
    • +
  • TO pnf( esr-thirdparty-sdnc has pnf, One2Many)
    • +
  • ESR-THIRDPARTY-SDNC deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    • @@ -149933,7 +168660,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-system-info-list: - object[] + object
    @@ -149942,7 +168669,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info + esr-system-info-list @@ -149953,7 +168680,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -149962,7 +168689,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -150026,7 +168753,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persist VNFM address information used by VF-C.

      -
    • TO esr-system-info (comprises esr-vnfm, One2One)
    +
  • TO esr-system-info (CHILD of esr-vnfm, esr-vnfm has esr-system-info, One2One)
    • +
  • ESR-VNFM deletion means associated objects of these types are also DELETED:ESR-SYSTEM-INFO
    • @@ -150083,7 +168811,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-system-info-list: - object[] + object
    @@ -150092,7 +168820,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-system-info + esr-system-info-list @@ -150103,7 +168831,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    relationship-list: - object[] + object
    @@ -150112,7 +168840,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - relationship + relationship-list @@ -150162,6 +168890,268 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    evc: + object + + + +

    +
    +
    +
    +

    evc object is an optional child object of the Configuration object.

    + +
      +
    • TO configuration( evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    + +
    + +
    +
    +
    + evc-id: + string + + + +
    +
    +

    Unique/key field for the evc object

    +
    + +
    +
    +
    + forwarding-path-topology: + string + + +
    +
    +

    Point-to-Point, Multi-Point

    +
    + +
    +
    +
    + cir-value: + string + + +
    +
    +

    Commited Information Rate

    +
    + +
    +
    +
    + cir-units: + string + + +
    +
    +

    CIR units

    +
    + +
    +
    +
    + connection-diversity-group-id: + string + + +
    +
    +

    Diversity Group ID

    +
    + +
    +
    +
    + service-hours: + string + + +
    +
    +

    formerly Performance Group

    +
    + +
    +
    +
    + esp-evc-circuit-id: + string + + +
    +
    +

    EVC Circuit ID of ESP EVC

    +
    + +
    +
    +
    + esp-evc-cir-value: + string + + +
    +
    +

    Committed Information Rate (For ESP)

    +
    + +
    +
    +
    + esp-evc-cir-units: + string + + +
    +
    +

    CIR units (For ESP)

    +
    + +
    +
    +
    + esp-itu-code: + string + + +
    +
    +

    Identifies ESP

    +
    + +
    +
    +
    + collector-pop-clli: + string + + +
    +
    +

    Collector POP CLLI (from the hostname of the access pnf)

    +
    + +
    +
    +
    + inter-connect-type-ingress: + string + + +
    +
    +

    Interconnect type on ingress side of EVC.

    +
    + +
    +
    +
    + tagmode-access-ingress: + string + + +
    +
    +

    tagode for collector side of EVC

    +
    + +
    +
    +
    + tagmode-access-egress: + string + + +
    +
    +

    tagMode for network side of EVC

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    evcs: + object + + + +

    +
    +
    + +
    +
    +
    + evc: + object[] + + +
    +
    + +
    + +
    + evc + + + +
    + +
    +
    +
    +
    +
    +
    +

    external-system: @@ -150181,7 +169171,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-ems-list: - object[] + object
    @@ -150190,7 +169180,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-ems + esr-ems-list @@ -150201,7 +169191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-vnfm-list: - object[] + object
    @@ -150210,7 +169200,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-vnfm + esr-vnfm-list @@ -150221,7 +169211,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    esr-thirdparty-sdnc-list: - object[] + object
    @@ -150230,7 +169220,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - esr-thirdparty-sdnc + esr-thirdparty-sdnc-list @@ -150337,8 +169327,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack flavor.

      -
    • FROM cloud-region (is composed of flavor)
      • -
    • FROM vserver
    +
  • TO cloud-region( flavor org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
    • +
  • FLAVOR cannot be deleted if linked to VSERVER
    • @@ -150544,6 +169535,438 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    forwarder: + object + + + +

    +
    +
    +
    +

    Entity describing a sequenced segment of forwarding path

    + +
      +
    • TO forwarding-path( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
      • +
    • TO l-interface( forwarder org.onap.relationships.inventory.ForwardsTo l-interface, MANY2ONE)
      • +
    • TO configuration( forwarder org.onap.relationships.inventory.Uses configuration, ONE2ONE)
      • +
    • TO lag-interface( forwarder org.onap.relationships.inventory.ForwardsTo lag-interface, MANY2ONE)
      • +
    • TO p-interface( forwarder org.onap.relationships.inventory.ForwardsTo p-interface, MANY2ONE)
      • +
    • FORWARDER deletion means associated objects of these types are also DELETED:CONFIGURATION
    + +
    + +
    +
    +
    + sequence: + integer + + + +
    +
    +

    Unique ID of this segmentation

    +
    + +
    +
    +
    + forwarder-role: + string + + +
    +
    +

    ingress, intermediate, egress

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    forwarder-evc: + object + + + +

    +
    +
    +
    +

    forwarder object is an optional child object of the Configuration object.

    + +
      +
    • TO configuration( forwarder-evc org.onap.relationships.inventory.BelongsTo configuration, ONE2ONE)
    + +
    + +
    +
    +
    + forwarder-evc-id: + string + + + +
    +
    +

    Key for forwarder-evc object

    +
    + +
    +
    +
    + circuit-id: + string + + +
    +
    +

    Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC

    +
    + +
    +
    +
    + ivlan: + string + + +
    +
    +

    Internal VLAN.

    +
    + +
    +
    +
    + svlan: + string + + +
    +
    +

    SVLAN value for ingress of egress forwarder.

    +
    + +
    +
    +
    + cvlan: + string + + +
    +
    +

    CVLAN value for ingress of egress forwarder.

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    forwarder-evcs: + object + + + +

    +
    +
    + +
    +
    +
    + forwarder-evc: + object[] + + +
    +
    + +
    + +
    + forwarder-evc + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    forwarders: + object + + + +

    +
    +
    + +
    +
    +
    + forwarder: + object[] + + +
    +
    + +
    + +
    + forwarder + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    forwarding-path: + object + + + +

    +
    +
    +
    +

    Entity that describes the sequenced forwarding path between interfaces of services or resources

    + +
      +
    • TO service-instance( forwarding-path org.onap.relationships.inventory.AppliesTo service-instance, MANY2ONE)
      • +
    • TO configuration( forwarding-path org.onap.relationships.inventory.Uses configuration, ONE2ONE)
      • +
    • FROM forwarder( forwarder org.onap.relationships.inventory.BelongsTo forwarding-path, MANY2ONE)
      • +
    • FORWARDING-PATH is DELETED when these are DELETED FORWARDER
      • +
    • FORWARDING-PATH deletion means associated objects of these types are also DELETED:CONFIGURATION
    + +
    + +
    +
    +
    + forwarding-path-id: + string + + + +
    +
    +

    Unique ID of this FP

    +
    + +
    +
    +
    + forwarding-path-name: + string + + + +
    +
    +

    Name of the FP

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + selflink: + string + + +
    +
    +

    the self link for this FP

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    + forwarders: + object[] + + +
    +
    + +
    + +
    + forwarder + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    forwarding-paths: + object + + + +

    +
    +
    + +
    +
    +
    + forwarding-path: + object[] + + +
    +
    + +
    + +
    + forwarding-path + + + +
    + +
    +
    +
    +
    +
    +
    +

    generic-vnf: @@ -150558,33 +169981,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General purpose VNF

      -
    • 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 configuration (One2Many)
      • -
    • TO vf-module (comprises generic-vnf, One2Many)
      • -
    • TO volume-group (One2Many)
      • -
    • TO vnfc (One2Many)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO entitlement (comprises generic-vnf, One2Many)
      • -
    • TO license (comprises generic-vnf, One2Many)
      • -
    • TO complex (Many2Many)
      • -
    • TO ctag-pool (Many2Many)
      • -
    • FROM line-of-business
      • -
    • FROM platform
      • -
    • FROM virtual-data-center
      • -
    • FROM logical-link
      • -
    • FROM allotted-resource
    +
  • TO availability-zone( generic-vnf org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • TO complex( generic-vnf org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • TO configuration( generic-vnf org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • TO ctag-pool( generic-vnf org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • +
  • TO instance-group( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO ipsec-configuration( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • +
  • TO l3-network( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO license-key-resource( generic-vnf org.onap.relationships.inventory.Uses license-key-resource, MANY2MANY)
    • +
  • TO pnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
    • +
  • TO pserver( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • +
  • TO vnf-image( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • TO volume-group( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • TO vserver( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • TO virtual-data-center( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf generic-vnf, MANY2MANY)
    • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM network-profile( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • FROM site-pair-set( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • FROM line-of-business( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • FROM platform( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • +
  • GENERIC-VNF is DELETED when these are DELETED ENTITLEMENT,VNFC,LAG-INTERFACE,LICENSE,L-INTERFACE,VF-MODULE
    • +
  • GENERIC-VNF deletion means associated objects of these types are also DELETED:CONFIGURATION

    • @@ -150603,6 +170028,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + vnf-instance-id: + string + + + +
    +
    +

    vnf instance id.

    +
    + +
    +
    vnf-name: string @@ -150725,6 +170163,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + vnf-package-name: + string + + + +
    +
    +
    + +
    +
    +
    + vnf-discriptor-name: + string + + + +
    +
    +

    vnf discriptor name

    +
    + +
    +
    +
    + job-id: + string + + + +
    +
    +

    job id corresponding to vnf

    +
    + +
    +
    heat-stack-id: string @@ -150881,6 +170357,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + nshd: + integer + + +
    +
    +

    number of associated SHD in vnf.

    +
    + +
    +
    +
    + nvm: + integer + + +
    +
    +

    number of vms in vnf.

    +
    + +
    +
    +
    + nnet: + integer + + +
    +
    +

    number of network in vnf.

    +
    + +
    +
    in-maint: boolean @@ -151372,9 +170884,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack group-assignment used to store exclusivity groups (EG).

      -
    • TO tenant (Many2Many)
      • -
    • TO pserver (One2Many)
      • -
    • FROM cloud-region (is composed of group-assignment)
    +
  • TO cloud-region( group-assignment org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
    • @@ -151521,7 +171033,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM subnet (is composed of host-route)
    +
  • TO subnet( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
    • @@ -151614,43 +171126,294 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    -
    -

    host-routes: - object - - - -

    -
    -
    - -
    -
    -
    - host-route: - object[] - - -
    -
    - -
    - -
    - host-route - - - -
    - -
    -
    -
    -
    -
    -
    -
    +
    +
    +

    host-routes: + object + + + +

    +
    +
    + +
    +
    +
    + host-route: + object[] + + +
    +
    + +
    + +
    + host-route + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-capabilities: + object + + + +

    +
    +
    +
    +

    Collection of HPA Capabilities

    + +
    + +
    +
    +
    + hpa-capability: + object[] + + +
    +
    + +
    + +
    + hpa-capability + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-capability: + object + + + +

    +
    +
    +
    +

    Represents a HPA capability

    + +
      +
    • TO flavor( hpa-capability org.onap.relationships.inventory.BelongsTo flavor, MANY2ONE)
      • +
    • TO cloud-region( hpa-capability org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
      • +
    • FROM hpa-feature-attributes( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
      • +
    • HPA-CAPABILITY is DELETED when these are DELETED HPA-FEATURE-ATTRIBUTES
    + +
    + +
    +
    +
    + hpa-capability-id: + string + + + +
    +
    +

    UUID to uniquely identify a HPA capability

    +
    + +
    +
    +
    + hpa-feature: + string + + + +
    +
    +

    Name of the HPACapability

    +
    + +
    +
    +
    + hpa-version: + string + + +
    +
    +

    HPA schema version

    +
    + +
    +
    +
    + architecture: + string + + +
    +
    +

    Hardware architecture

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    + hpa-feature-attributes: + object[] + + +
    +
    + +
    + +
    + hpa-feature-attributes + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    hpa-feature-attributes: + object + + + +

    +
    +
    +
    +

    HPA Capability Feature attributes

    + +
      +
    • TO hpa-capability( hpa-feature-attributes org.onap.relationships.inventory.BelongsTo hpa-capability, MANY2ONE)
    + +
    + +
    +
    +
    + hpa-attribute-key: + string + + + +
    +
    +

    name of the specific HPA attribute

    +
    + +
    +
    +
    + hpa-attribute-value: + string + + +
    +
    +

    JSON string specifying the value, unit and type of the specific HPA attribute

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +

    image: @@ -151665,9 +171428,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack image.

      -
    • TO metadatum (comprises image, Many2Many)
      • -
    • FROM cloud-region (is composed of image)
      • -
    • FROM vserver
    +
  • TO cloud-region( image org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
    • +
  • IMAGE cannot be deleted if linked to VSERVER
    • +
  • IMAGE is DELETED when these are DELETED METADATUM
    • @@ -151987,16 +171752,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    General mechanism for grouping instances

      -
    • 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
    +
  • TO model( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • @@ -152353,7 +172120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - + aai-internal @@ -152611,8 +172378,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    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

      -
    • TO vig-server (comprises ipsec-configuration, One2Many)
      • -
    • FROM generic-vnf
    +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses ipsec-configuration, MANY2ONE)
    • +
  • FROM vig-server( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
    • +
  • IPSEC-CONFIGURATION is DELETED when these are DELETED VIG-SERVER
    • @@ -153017,20 +172785,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical interfaces, e.g., a vnic.

      -
    • 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)
      • -
    • 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 vserver (is composed of l-interface)
      • -
    • FROM allotted-resource
      • -
    • FROM l-interface (is composed of l-interface)
    +
  • TO generic-vnf( l-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO lag-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • +
  • TO instance-group( l-interface org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • TO logical-link( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • +
  • TO newvce( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • TO p-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • +
  • TO vserver( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses l-interface, ONE2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • FROM vlan( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • L-INTERFACE is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,SRIOV-VF,VLAN
    • +
  • L-INTERFACE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -153396,12 +173166,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One)
      • -
    • FROM l-interface (is composed of l3-interface-ipv4-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv4-address-list)
    +
  • TO instance-group( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • +
  • TO l3-network( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • TO subnet( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • TO l-interface( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • TO vlan( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    • +
  • TO vnfc( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
    • @@ -153542,12 +173312,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

      -
    • TO instance-group (Many2Many)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO subnet (Many2Many)
      • -
    • TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One)
      • -
    • FROM l-interface (is composed of l3-interface-ipv6-address-list)
      • -
    • FROM vlan (is composed of l3-interface-ipv6-address-list)
    +
  • TO instance-group( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf instance-group, MANY2MANY)
    • +
  • TO l3-network( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • TO subnet( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • TO l-interface( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo l-interface, MANY2ONE)
    • +
  • TO vlan( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    • +
  • TO vnfc( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
    • @@ -153688,22 +173458,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Generic network definition

      -
    • 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
    +
  • TO instance-group( l3-network org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO network-policy( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • +
  • TO route-table-reference( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • +
  • TO vpn-binding( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf l3-network, MANY2MANY)
    • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM complex( complex org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf l3-network, MANY2MANY)
    • +
  • FROM ctag-assignment( ctag-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM segmentation-assignment( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • +
  • FROM subnet( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • L3-NETWORK is DELETED when these are DELETED CTAG-ASSIGNMENT,SEGMENTATION-ASSIGNMENT,SUBNET
    • @@ -154158,14 +173929,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Link aggregate interface

      -
    • TO logical-link (Many2Many)
      • -
    • TO lag-link (Many2Many)
      • -
    • 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 vpls-pe (is composed of lag-interface)
    +
  • TO generic-vnf( lag-interface org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO lag-link( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
    • +
  • TO logical-link( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO p-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • +
  • TO pnf( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • TO pserver( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • TO vpls-pe( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo lag-interface, MANY2ONE)
    • +
  • LAG-INTERFACE is DELETED when these are DELETED L-INTERFACE
    • +
  • LAG-INTERFACE deletion means associated objects of these types are also DELETED:LAG-LINK,LOGICAL-LINK
    • @@ -154379,8 +174152,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    LAG links can connect lag-interfaces

      -
    • FROM lag-interface
      • -
    • FROM logical-link
    +
  • FROM lag-interface( lag-interface tosca.relationships.network.LinksTo lag-link, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
    • @@ -154490,8 +174263,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Metadata for license group.

      -
    • FROM generic-vnf (is composed of license)
      • -
    • FROM vce (is composed of license)
    +
  • TO generic-vnf( license org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO vce( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • @@ -154614,7 +174387,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes a line-of-business

      -
    • TO generic-vnf (Many2Many)
    +
  • TO generic-vnf( line-of-business org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • @@ -154724,21 +174497,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Logical links generally connect l-interfaces but are used to express logical connectivity between two points

      -
    • 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 configuration
      • -
    • FROM l-interface
      • -
    • FROM lag-interface
      • -
    • FROM p-interface
      • -
    • FROM service-instance
      • -
    • FROM virtual-data-center
      • -
    • FROM vlan
      • -
    • FROM logical-link
    +
  • TO cloud-region( logical-link org.onap.relationships.inventory.LocatedIn cloud-region, MANY2MANY)
    • +
  • TO generic-vnf( logical-link org.onap.relationships.inventory.BridgedTo generic-vnf, MANY2MANY)
    • +
  • TO lag-link( logical-link org.onap.relationships.inventory.Uses lag-link, MANY2MANY)
    • +
  • TO logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO pnf( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • +
  • TO pserver( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
    • +
  • TO vpn-binding( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • TO virtual-data-center( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM configuration( configuration org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • FROM l-interface( l-interface tosca.relationships.network.LinksTo logical-link, MANY2MANY)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • @@ -155106,11 +174879,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Key/value pairs

      -
    • FROM configuration (is composed of metadatum)
      • -
    • 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)
    +
  • TO configuration( metadatum org.onap.relationships.inventory.BelongsTo configuration, MANY2ONE)
    • +
  • TO connector( metadatum org.onap.relationships.inventory.BelongsTo connector, MANY2ONE)
    • +
  • TO image( metadatum org.onap.relationships.inventory.BelongsTo image, MANY2ONE)
    • +
  • TO service-instance( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • TO model-ver( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • @@ -155170,10 +174943,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version

      -
    • TO model-ver (comprises model, One2Many)
      • -
    • FROM named-query
      • -
    • FROM named-query-element
      • -
    • FROM instance-group
    +
  • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • +
  • FROM instance-group( instance-group org.onap.relationships.inventory.Targets model, MANY2MANY)
    • +
  • FROM model-ver( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • +
  • FROM named-query( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
    • +
  • FROM named-query-element( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
    • +
  • MODEL cannot be deleted if linked to INSTANCE-GROUP,NAMED-QUERY,NAMED-QUERY-ELEMENT
    • +
  • MODEL is DELETED when these are DELETED MODEL-VER
    • @@ -155378,8 +175154,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This is how we would capture constraints defining allowed sets of elements.

      -
    • TO constrained-element-set (comprises model-constraint, One2Many)
      • -
    • FROM model-element (is composed of model-constraint)
    +
  • TO model-element( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • +
  • FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-constraint, MANY2ONE)
    • +
  • MODEL-CONSTRAINT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET
    • @@ -155496,13 +175273,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Defines how other models combine to make up a higher-level model.

      -
    • 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)
    +
  • TO element-choice-set( model-element org.onap.relationships.inventory.BelongsTo element-choice-set, MANY2ONE)
    • +
  • TO model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • +
  • TO model-ver( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
    • +
  • TO model-ver( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • FROM constrained-element-set( constrained-element-set org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • +
  • FROM model-constraint( model-constraint org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-element, MANY2ONE)
    • +
  • MODEL-ELEMENT is DELETED when these are DELETED CONSTRAINED-ELEMENT-SET,MODEL-CONSTRAINT
    • @@ -155684,10 +175462,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models

      -
    • TO model-element (comprises model-ver, One2Many)
      • -
    • TO metadatum (comprises model-ver, One2Many)
      • -
    • FROM model (is composed of model-ver)
      • -
    • FROM model-element
    +
  • TO model( model-ver org.onap.relationships.inventory.BelongsTo model, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.IsA model-ver, MANY2ONE)
    • +
  • FROM model-element( model-element org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo model-ver, MANY2ONE)
    • +
  • MODEL-VER cannot be deleted if linked to MODEL-ELEMENT
    • +
  • MODEL-VER is DELETED when these are DELETED MODEL-ELEMENT,METADATUM
    • @@ -155911,7 +175691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM vlan
    +
  • FROM vlan( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
    • @@ -156084,8 +175864,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • TO model (One2Many)
      • -
    • TO named-query-element (comprises named-query, One2One)
    +
  • TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
    • +
  • TO model( named-query org.onap.relationships.inventory.AppliesTo model, ONE2MANY)
    • +
  • FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
    • +
  • NAMED-QUERY is DELETED when these are DELETED NAMED-QUERY-ELEMENT
    • @@ -156218,12 +176000,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • 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)
    +
  • TO named-query( named-query-element org.onap.relationships.inventory.BelongsTo named-query, ONE2ONE)
    • +
  • TO model( named-query-element org.onap.relationships.inventory.IsA model, MANY2ONE)
    • +
  • TO named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • +
  • FROM property-constraint( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • +
  • FROM related-lookup( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • +
  • FROM named-query-element( named-query-element org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • +
  • NAMED-QUERY-ELEMENT is DELETED when these are DELETED PROPERTY-CONSTRAINT,RELATED-LOOKUP
    • @@ -156783,29 +176566,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    - vip-ipv4-address-list: - object - - -
    -
    - -
    - -
    - vip-ipv4-address-list - - - -
    - -
    -
    -
    -
    - vip-ipv6-address-list: - object +
    + configurations: + object[]
    @@ -156814,7 +176577,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    - vip-ipv6-address-list + configurations @@ -156877,8 +176640,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • FROM l3-network
      • -
    • FROM allotted-resource
    +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.Uses network-policy, ONE2ONE)
    • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses network-policy, MANY2MANY)
    • @@ -156971,7 +176734,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Network profile populated by SDN-GP for SNMP

      -
    • FROM generic-vnf
    +
  • TO generic-vnf( network-profile org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • @@ -157093,7 +176856,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

      -
    • TO l-interface (comprises newvce, Many2Many)
    +
  • FROM l-interface( l-interface org.onap.relationships.inventory.BelongsTo newvce, MANY2ONE)
    • +
  • NEWVCE is DELETED when these are DELETED L-INTERFACE
    • @@ -157659,9 +177423,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    OAM network, to be deprecated shortly. Do not use for new purposes.

      -
    • TO complex (Many2Many)
      • -
    • TO service-capability (Many2Many)
      • -
    • FROM cloud-region (is composed of oam-network)
    +
  • TO cloud-region( oam-network org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • TO complex( oam-network org.onap.relationships.inventory.AppliesTo complex, MANY2MANY)
    • +
  • TO service-capability( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • @@ -157807,6 +177571,182 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
    +

    operational-environment: + object + + + +

    +
    +
    +
    +

    It is a logical partition of the cloud which allows to have multiple environments in the production AIC.

    + +
      +
    • TO operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
      • +
    • FROM operational-environment( operational-environment org.onap.relationships.inventory.Uses operational-environment, ONE2ONE)
    + +
    + +
    +
    +
    + operational-environment-id: + string + + + +
    +
    +

    UUID of an operational environment

    +
    + +
    +
    +
    + operational-environment-name: + string + + + +
    +
    +

    Operational Environment name

    +
    + +
    +
    +
    + operational-environment-type: + string + + + +
    +
    +

    Operational Environment Type.

    +
    + +
    +
    +
    + operational-environment-status: + string + + + +
    +
    +

    Status

    +
    + +
    +
    +
    + tenant-context: + string + + + +
    +
    +

    Tenant Context.

    +
    + +
    +
    +
    + workload-context: + string + + + +
    +
    +

    Workload Context.

    +
    + +
    +
    +
    + resource-version: + string + + +
    +
    +

    Used for optimistic concurrency. Must be empty on create, valid on update and delete.

    +
    + +
    +
    +
    + relationship-list: + object[] + + +
    +
    + +
    + +
    + relationship + + + +
    + +
    +
    +
    +
    +
    +
    +
    +
    +
    +

    operational-environments: + object + + + +

    +
    +
    +
    +

    a logical partition of the cloud which allows to have multiple environments in the production AIC.

    + +
    + +
    +
    +
    + operational-environment: + object[] + + +
    +
    + +
    + +
    + operational-environment + + + +
    + +
    +
    +
    +
    +
    +
    +

    overloaded-model: @@ -158025,7 +177965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes an owning-entity

      -
    • TO service-instance (One2Many)
    +
  • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
    • @@ -158107,14 +178047,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Physical interface (e.g., nic)

      -
    • TO l-interface (comprises p-interface, Many2Many)
      • -
    • TO physical-link (Many2Many)
      • -
    • 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)
    +
  • TO logical-link( p-interface tosca.relationships.network.LinksTo logical-link, MANY2ONE)
    • +
  • TO physical-link( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    • +
  • TO pnf( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • TO pserver( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • TO vpls-pe( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM lag-interface( lag-interface org.onap.relationships.inventory.Uses p-interface, MANY2MANY)
    • +
  • FROM l-interface( l-interface tosca.relationships.network.BindsTo p-interface, MANY2ONE)
    • +
  • FROM sriov-pf( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
    • +
  • P-INTERFACE is DELETED when these are DELETED L-INTERFACE,SRIOV-PF
    • +
  • P-INTERFACE deletion means associated objects of these types are also DELETED:PHYSICAL-LINK
    • @@ -158384,7 +178326,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Collection of physical connections, typically between p-interfaces

      -
    • FROM p-interface
    +
  • FROM p-interface( p-interface tosca.relationships.network.LinksTo physical-link, MANY2ONE)
    • @@ -158614,7 +178556,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes a platform

      -
    • TO generic-vnf (Many2Many)
    +
  • TO generic-vnf( platform org.onap.relationships.inventory.Uses generic-vnf, MANY2MANY)
    • @@ -158724,15 +178666,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.

      -
    • TO p-interface (comprises pnf, Many2Many)
      • -
    • TO lag-interface (comprises pnf, One2Many)
      • -
    • TO complex (Many2One)
      • -
    • TO instance-group (Many2Many)
      • -
    • TO zone (Many2One)
      • -
    • FROM esr-thirdparty-sdnc
      • -
    • FROM generic-vnf
      • -
    • FROM logical-link
      • -
    • FROM service-instance
    +
  • TO complex( pnf org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO instance-group( pnf org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO zone( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM esr-thirdparty-sdnc( esr-thirdparty-sdnc has pnf, One2Many)
    • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pnf, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pnf, MANY2MANY)
    • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo pnf, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • +
  • PNF is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    • @@ -159122,8 +179065,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Used to capture the network interfaces of this VCE

      -
    • TO cvlan-tag (comprises port-group, Many2Many)
      • -
    • FROM vce (is composed of port-group)
    +
  • TO vce( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • +
  • FROM cvlan-tag( cvlan-tag org.onap.relationships.inventory.BelongsTo port-group, MANY2ONE)
    • +
  • PORT-GROUP is DELETED when these are DELETED CVLAN-TAG
    • @@ -159358,7 +179302,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    describes the project

      -
    • TO service-instance (One2Many)
    +
  • TO service-instance( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
    • @@ -159511,7 +179455,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • FROM named-query-element (is composed of property-constraint)
    +
  • TO named-query-element( property-constraint org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • @@ -159631,16 +179575,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.

      -
    • 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
    +
  • TO group-assignment( pserver org.onap.relationships.inventory.MemberOf group-assignment, MANY2ONE)
    • +
  • TO availability-zone( pserver org.onap.relationships.inventory.MemberOf availability-zone, MANY2ONE)
    • +
  • TO cloud-region( pserver org.onap.relationships.inventory.LocatedIn cloud-region, MANY2ONE)
    • +
  • TO complex( pserver org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO zone( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn pserver, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.BridgedTo pserver, MANY2MANY)
    • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo pserver, MANY2ONE)
    • +
  • FROM vserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
    • +
  • PSERVER cannot be deleted if linked to GENERIC-VNF,LOGICAL-LINK,VSERVER
    • +
  • PSERVER is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    • +
  • PSERVER cannot be deleted if linked to GROUP-ASSIGNMENT
    • @@ -160151,7 +180098,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    TBD

      -
    • FROM named-query-element (is composed of related-lookup)
    +
  • TO named-query-element( related-lookup org.onap.relationships.inventory.BelongsTo named-query-element, MANY2ONE)
    • @@ -160395,26 +180342,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    -
    -
    - -
    - related-to-property: - object[] - - -
    -
    - -
    - -
    - related-to-property - - - -
    -
    @@ -160696,7 +180623,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack route table reference.

      -
    • FROM l3-network
    +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses route-table-reference, MANY2MANY)
    • @@ -160819,7 +180746,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Route target information

      -
    • FROM vpn-binding (is composed of route-target)
    +
  • TO vpn-binding( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • @@ -160941,8 +180868,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO site-pair (comprises routing-instance, Many2Many)
      • -
    • FROM site-pair-set (is composed of routing-instance)
    +
  • TO site-pair-set( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
    • +
  • FROM site-pair( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
    • +
  • ROUTING-INSTANCE is DELETED when these are DELETED SITE-PAIR
    • @@ -161387,7 +181315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack segmentation assignment.

      -
    • FROM l3-network (is composed of segmentation-assignment)
    +
  • TO l3-network( segmentation-assignment org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • @@ -161641,8 +181569,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.

      -
    • FROM availability-zone
      • -
    • FROM oam-network
    +
  • FROM availability-zone( availability-zone org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • +
  • FROM oam-network( oam-network org.onap.relationships.inventory.AppliesTo service-capability, MANY2MANY)
    • +
  • SERVICE-CAPABILITY cannot be deleted if linked to AVAILABILITY-ZONE,OAM-NETWORK
    • @@ -161845,26 +181774,28 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Instance of a service

      -
    • TO configuration (One2Many)
      • -
    • TO zone (Many2One)
      • -
    • TO cvlan-tag (Many2Many)
      • -
    • TO pnf (One2Many)
      • -
    • TO connector (Many2Many)
      • -
    • TO metadatum (comprises service-instance, Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • 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 owning-entity
      • -
    • FROM project
      • -
    • FROM service-subscription (is composed of service-instance)
      • -
    • FROM vce
      • -
    • FROM service-instance
    +
  • TO generic-vnf( service-instance org.onap.relationships.inventory.ComposedOf generic-vnf, ONE2MANY)
    • +
  • TO l3-network( service-instance org.onap.relationships.inventory.ComposedOf l3-network, ONE2MANY)
    • +
  • TO owning-entity( service-instance org.onap.relationships.inventory.BelongsTo owning-entity, MANY2ONE)
    • +
  • TO allotted-resource( service-instance org.onap.relationships.inventory.Uses allotted-resource, MANY2MANY)
    • +
  • TO configuration( service-instance org.onap.relationships.inventory.Uses configuration, ONE2MANY)
    • +
  • TO connector( service-instance org.onap.relationships.inventory.Uses connector, MANY2MANY)
    • +
  • TO ctag-assignment( service-instance org.onap.relationships.inventory.Uses ctag-assignment, ONE2MANY)
    • +
  • TO cvlan-tag( service-instance org.onap.relationships.inventory.ComposedOf cvlan-tag, MANY2MANY)
    • +
  • TO instance-group( service-instance org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO logical-link( service-instance org.onap.relationships.inventory.Uses logical-link, ONE2MANY)
    • +
  • TO pnf( service-instance org.onap.relationships.inventory.ComposedOf pnf, ONE2MANY)
    • +
  • TO service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • TO vlan( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
    • +
  • TO zone( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • TO service-subscription( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
    • +
  • TO vce( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
    • +
  • FROM project( project org.onap.relationships.inventory.Uses service-instance, ONE2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM metadatum( metadatum org.onap.relationships.inventory.BelongsTo service-instance, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf service-instance, ONE2MANY)
    • +
  • SERVICE-INSTANCE is DELETED when these are DELETED ALLOTTED-RESOURCE,METADATUM
    • +
  • SERVICE-INSTANCE deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -161945,6 +181876,45 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    + created-at: + string + + + +
    +
    +

    create time of Network Service.

    +
    + +
    +
    +
    + updated-at: + string + + + +
    +
    +

    last update of Network Service.

    +
    + +
    +
    +
    + description: + string + + + +
    +
    +

    short description for service-instance.

    +
    + +
    +
    model-invariant-id: string @@ -162244,9 +182214,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Object that group service instances.

      -
    • TO service-instance (comprises service-subscription, Many2Many)
      • -
    • FROM customer (is composed of service-subscription)
      • -
    • FROM tenant
    +
  • TO customer( service-subscription org.onap.relationships.inventory.BelongsTo customer, MANY2ONE)
    • +
  • TO tenant( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.BelongsTo service-subscription, MANY2ONE)
    • +
  • SERVICE-SUBSCRIPTION is DELETED when these are DELETED SERVICE-INSTANCE
    • @@ -162428,8 +182399,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO class-of-service (comprises site-pair, Many2Many)
      • -
    • FROM routing-instance (is composed of site-pair)
    +
  • TO routing-instance( site-pair org.onap.relationships.inventory.BelongsTo routing-instance, MANY2ONE)
    • +
  • FROM class-of-service( class-of-service org.onap.relationships.inventory.BelongsTo site-pair, MANY2ONE)
    • +
  • SITE-PAIR is DELETED when these are DELETED CLASS-OF-SERVICE
    • @@ -162578,8 +182550,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Set of instances for probes used to measure service level agreements

      -
    • TO routing-instance (comprises site-pair-set, Many2Many)
      • -
    • FROM generic-vnf
    +
  • TO generic-vnf( site-pair-set org.onap.relationships.inventory.AppliesTo generic-vnf, MANY2MANY)
    • +
  • FROM routing-instance( routing-instance org.onap.relationships.inventory.BelongsTo site-pair-set, MANY2ONE)
    • +
  • SITE-PAIR-SET is DELETED when these are DELETED ROUTING-INSTANCE
    • @@ -162750,8 +182723,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack snapshot

      -
    • FROM cloud-region (is composed of snapshot)
      • -
    • FROM vserver
    +
  • TO cloud-region( snapshot org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
    • @@ -162969,8 +182942,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    SR-IOV Physical Function

      -
    • FROM p-interface (is composed of sriov-pf)
      • -
    • FROM sriov-vf
    +
  • TO p-interface( sriov-pf org.onap.relationships.inventory.BelongsTo p-interface, ONE2ONE)
    • +
  • FROM sriov-vf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
    • @@ -163080,8 +183053,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    SR-IOV Virtual Function (not to be confused with virtual network function)

      -
    • TO sriov-pf (Many2One)
      • -
    • FROM l-interface (is composed of sriov-vf)
    +
  • TO l-interface( sriov-vf org.onap.relationships.inventory.BelongsTo l-interface, ONE2ONE)
    • +
  • TO sriov-pf( sriov-vf org.onap.relationships.inventory.Uses sriov-pf, MANY2ONE)
    • @@ -163373,10 +183346,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO host-route (comprises subnet, One2Many)
      • -
    • FROM l3-interface-ipv4-address-list
      • -
    • FROM l3-interface-ipv6-address-list
      • -
    • FROM l3-network (is composed of subnet)
    +
  • TO l3-network( subnet org.onap.relationships.inventory.BelongsTo l3-network, MANY2ONE)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.network.MemberOf subnet, MANY2MANY)
    • +
  • FROM host-route( host-route org.onap.relationships.inventory.BelongsTo subnet, MANY2ONE)
    • +
  • FROM vip-ipv4-address-list( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • +
  • FROM vip-ipv6-address-list( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • +
  • SUBNET cannot be deleted if linked to L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST,VIP-IPV4-ADDRESS-LIST,VIP-IPV6-ADDRESS-LIST
    • +
  • SUBNET is DELETED when these are DELETED HOST-ROUTE
    • @@ -163695,12 +183672,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Openstack tenant

      -
    • 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
    +
  • TO cloud-region( tenant org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • TO group-assignment( tenant org.onap.relationships.inventory.MemberOf group-assignment, MANY2MANY)
    • +
  • TO l3-network( tenant org.onap.relationships.inventory.Uses l3-network, MANY2MANY)
    • +
  • TO volume-group( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • FROM service-subscription( service-subscription org.onap.relationships.inventory.Uses tenant, MANY2MANY)
    • +
  • FROM vserver( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
    • +
  • TENANT cannot be deleted if linked to VSERVER
    • @@ -163855,7 +183833,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted

      -
    • FROM allotted-resource (is composed of tunnel-xconnect)
    +
  • TO allotted-resource( tunnel-xconnect org.onap.relationships.inventory.BelongsTo allotted-resource, ONE2ONE)
    • @@ -164140,13 +184118,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.

      -
    • 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)
    +
  • TO availability-zone( vce org.onap.relationships.inventory.Uses availability-zone, MANY2MANY)
    • +
  • TO complex( vce org.onap.relationships.inventory.LocatedIn complex, MANY2MANY)
    • +
  • TO vserver( vce tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • FROM entitlement( entitlement org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • +
  • FROM license( license org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • +
  • FROM port-group( port-group org.onap.relationships.inventory.BelongsTo vce, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vce, ONE2MANY)
    • +
  • VCE is DELETED when these are DELETED ENTITLEMENT,LICENSE,PORT-GROUP
    • @@ -164522,11 +184501,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    a deployment unit of VNFCs

      -
    • TO volume-group (One2One)
      • -
    • TO l3-network (Many2Many)
      • -
    • TO vnfc (One2Many)
      • -
    • FROM vserver
      • -
    • FROM generic-vnf (is composed of vf-module)
    +
  • TO generic-vnf( vf-module org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO l3-network( vf-module org.onap.relationships.inventory.DependsOn l3-network, MANY2MANY)
    • +
  • TO vnfc( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • +
  • TO volume-group( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
    • +
  • TO vserver( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
    • +
  • VF-MODULE cannot be deleted if linked to VNFC
    • @@ -164792,7 +184772,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607

      -
    • FROM ipsec-configuration (is composed of vig-server)
    +
  • TO ipsec-configuration( vig-server org.onap.relationships.inventory.BelongsTo ipsec-configuration, MANY2ONE)
    • @@ -164922,7 +184902,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv4 Address Range

      -
    • FROM vnfc
    +
  • TO cloud-region( vip-ipv4-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • TO instance-group( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO subnet( vip-ipv4-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
    • @@ -165063,7 +185046,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    IPv6 Address Range

      -
    • FROM vnfc
    +
  • TO cloud-region( vip-ipv6-address-list org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • TO instance-group( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO subnet( vip-ipv6-address-list org.onap.relationships.inventory.MemberOf subnet, MANY2MANY)
    • +
  • FROM vnfc( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
    • @@ -165204,9 +185190,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual organization of cloud infrastructure elements in a data center context

      -
    • TO generic-vnf (Many2Many)
      • -
    • TO logical-link (Many2Many)
      • -
    • FROM connector
    +
  • FROM connector( connector org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.LocatedIn virtual-data-center, MANY2MANY)
    • @@ -165329,13 +185315,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Definition of vlan

      -
    • 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)
      • -
    • FROM l-interface (is composed of vlan)
      • -
    • FROM service-instance
      • -
    • FROM allotted-resource
    +
  • TO l-interface( vlan tosca.relationships.network.LinksTo l-interface, MANY2ONE)
    • +
  • TO logical-link( vlan org.onap.relationships.inventory.Uses logical-link, MANY2MANY)
    • +
  • TO multicast-configuration( vlan org.onap.relationships.inventory.Uses multicast-configuration, MANY2MANY)
    • +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.PartOf vlan, MANY2MANY)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.ComposedOf vlan, ONE2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vlan, MANY2ONE)
    • +
  • VLAN is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
    • +
  • VLAN deletion means associated objects of these types are also DELETED:LOGICAL-LINK
    • @@ -165647,7 +185635,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.

      -
    • FROM generic-vnf
    +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.Uses vnf-image, MANY2ONE)
    • +
  • VNF-IMAGE cannot be deleted if linked to GENERIC-VNF
    • @@ -165806,14 +185795,15 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
    • TO instance-group (Many2Many)
      • -
    • TO vip-ipv4-address-list (Many2Many)
      • -
    • TO vip-ipv6-address-list (Many2Many)
      • -
    • FROM vserver
      • -
    • FROM vf-module
      • -
    • FROM generic-vnf
      • -
    • FROM l3-interface-ipv4-address-list (comprises vnfc)
      • -
    • FROM l3-interface-ipv6-address-list (comprises vnfc)
    +
  • TO generic-vnf( vnfc org.onap.relationships.inventory.BelongsTo generic-vnf, MANY2ONE)
    • +
  • TO instance-group( vnfc org.onap.relationships.inventory.MemberOf instance-group, MANY2MANY)
    • +
  • TO vip-ipv4-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv4-address-list, MANY2MANY)
    • +
  • TO vip-ipv6-address-list( vnfc org.onap.relationships.inventory.Uses vip-ipv6-address-list, MANY2MANY)
    • +
  • TO vserver( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vnfc, ONE2MANY)
    • +
  • FROM l3-interface-ipv4-address-list( l3-interface-ipv4-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
    • +
  • FROM l3-interface-ipv6-address-list( l3-interface-ipv6-address-list org.onap.relationships.inventory.BelongsTo vnfc, MANY2ONE)
    • +
  • VNFC is DELETED when these are DELETED L3-INTERFACE-IPV4-ADDRESS-LIST,L3-INTERFACE-IPV6-ADDRESS-LIST
    • @@ -166085,7 +186075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Ephemeral Block storage volume.

      -
    • FROM vserver (is composed of volume)
    +
  • FROM vserver (PARENT of volume, vserver tosca.relationships.AttachesTo volume)
    • @@ -166167,11 +186157,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Persistent block-level storage.

      -
    • TO complex (Many2Many)
      • -
    • TO tenant (Many2Many)
      • -
    • FROM cloud-region (is composed of volume-group)
      • -
    • FROM vf-module
      • -
    • FROM generic-vnf
    +
  • TO cloud-region( volume-group org.onap.relationships.inventory.BelongsTo cloud-region, MANY2ONE)
    • +
  • TO complex( volume-group org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM generic-vnf( generic-vnf org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses volume-group, ONE2ONE)
    • +
  • FROM tenant( tenant org.onap.relationships.inventory.DependsOn volume-group, ONE2MANY)
    • @@ -166396,10 +186386,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPLS Provider Edge routers.

      -
    • TO complex (Many2Many)
      • -
    • TO ctag-pool (Many2Many)
      • -
    • TO p-interface (comprises vpls-pe, Many2Many)
      • -
    • TO lag-interface (comprises vpls-pe, Many2Many)
    +
  • TO complex( vpls-pe org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • TO ctag-pool( vpls-pe org.onap.relationships.inventory.Uses ctag-pool, MANY2MANY)
    • +
  • FROM lag-interface( lag-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • FROM p-interface( p-interface tosca.relationships.network.BindsTo vpls-pe, MANY2ONE)
    • +
  • VPLS-PE is DELETED when these are DELETED LAG-INTERFACE,P-INTERFACE
    • @@ -166596,10 +186587,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    VPN binding

      -
    • TO route-target (comprises vpn-binding, One2Many)
      • -
    • FROM l3-network
      • -
    • FROM logical-link
      • -
    • FROM allotted-resource
    +
  • FROM allotted-resource( allotted-resource org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2MANY)
    • +
  • FROM l3-network( l3-network org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM logical-link( logical-link org.onap.relationships.inventory.Uses vpn-binding, MANY2MANY)
    • +
  • FROM route-target( route-target org.onap.relationships.inventory.BelongsTo vpn-binding, MANY2ONE)
    • +
  • VPN-BINDING cannot be deleted if linked to ALLOTTED-RESOURCE,L3-NETWORK,LOGICAL-LINK
    • +
  • VPN-BINDING is DELETED when these are DELETED ROUTE-TARGET
    • @@ -166798,17 +186791,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    Virtual Servers, aka virtual machine or VM.

      -
    • TO flavor (Many2One)
      • -
    • TO image (Many2One)
      • -
    • 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
    +
  • TO tenant( vserver org.onap.relationships.inventory.BelongsTo tenant, MANY2ONE)
    • +
  • TO flavor( vserver org.onap.relationships.inventory.Uses flavor, MANY2ONE)
    • +
  • TO image( vserver org.onap.relationships.inventory.Uses image, MANY2ONE)
    • +
  • TO pserver( vserver tosca.relationships.HostedOn pserver, MANY2ONE)
    • +
  • TO snapshot( vserver org.onap.relationships.inventory.Uses snapshot, ONE2ONE)
    • +
  • TO volume (CHILD of vserver, vserver tosca.relationships.AttachesTo volume, ONE2MANY)
    • +
  • FROM generic-vnf( generic-vnf tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • FROM vce( vce tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • FROM l-interface( l-interface tosca.relationships.network.BindsTo vserver, MANY2ONE)
    • +
  • FROM vf-module( vf-module org.onap.relationships.inventory.Uses vserver, ONE2MANY)
    • +
  • FROM vnfc( vnfc tosca.relationships.HostedOn vserver, ONE2MANY)
    • +
  • VSERVER is DELETED when these are DELETED L-INTERFACE
    • +
  • VSERVER deletion means associated objects of these types are also DELETED:VOLUME
    • @@ -167032,11 +187027,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

    A zone is a grouping of assets in a location homing to the same connections into the CBB

      -
    • TO complex (Many2One)
      • -
    • FROM cloud-region
      • -
    • FROM pserver
      • -
    • FROM pnf
      • -
    • FROM service-instance
    +
  • TO complex( zone org.onap.relationships.inventory.LocatedIn complex, MANY2ONE)
    • +
  • FROM cloud-region( cloud-region org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM pnf( pnf org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM pserver( pserver org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)
    • +
  • FROM service-instance( service-instance org.onap.relationships.inventory.LocatedIn zone, MANY2ONE)