From 4ffe31eeea74c618ccc8950ee63071f28bafbfc4 Mon Sep 17 00:00:00 2001 From: Venkata Harish K Kajur Date: Tue, 19 Sep 2017 01:43:31 -0400 Subject: Add owning entity, platform, line of business to the schema and generate xsd yaml and html Issue-ID: AAI-325 Change-Id: Ibf065b5aecbaf37effc41ea478d98314d6210603 Signed-off-by: Venkata Harish K Kajur --- .../main/resources/aai_schema/aai_schema_v11.xsd | 451 +- .../aai_swagger_html/aai_swagger_v11.html | 44501 ++++++++++++------- .../aai_swagger_yaml/aai_swagger_v11.yaml | 3245 +- aai-schema/src/main/resources/oxm/aai_oxm_v11.xml | 148 +- 4 files changed, 31359 insertions(+), 16986 deletions(-) (limited to 'aai-schema') diff --git a/aai-schema/src/main/resources/aai_schema/aai_schema_v11.xsd b/aai-schema/src/main/resources/aai_schema/aai_schema_v11.xsd index 2fd6bd6b..291bc6b3 100644 --- a/aai-schema/src/main/resources/aai_schema/aai_schema_v11.xsd +++ b/aai-schema/src/main/resources/aai_schema/aai_schema_v11.xsd @@ -1719,46 +1719,81 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - + - @org.openecomp.aai.annotations.Metadata(description="Persistent auth info.",indexedProps="auth-info-item-id,username,auth-url",searchable="auth-info-item-id,username,auth-url",dependentOn="cloud-region",container="auth-info-items") + @org.openecomp.aai.annotations.Metadata(description="Persist common address information of external systems.",indexedProps="esr-system-info-id,system-name,system-type",searchable="esr-system-info-id,system-name,system-type",container="esr-system-info-list",dependentOn="cloud-region,esr-ems,esr-vnfm,esr-thirdparty-sdnc") - + - @org.openecomp.aai.annotations.Metadata(isKey=true,description="Unique ID of auth-info-item.") + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Unique ID of esr system info.") - + - @org.openecomp.aai.annotations.Metadata(description="domain info for authentication.") + @org.openecomp.aai.annotations.Metadata(description="name of external system.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="type of external systems.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="vendor of external systems.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="version of external systems.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="url used to access external systems.") - + - @org.openecomp.aai.annotations.Metadata(description="user name of auth infomation to access VIM.") + @org.openecomp.aai.annotations.Metadata(description="username used to access external systems.") - @org.openecomp.aai.annotations.Metadata(description="password of auth infomation to access VIM.") + @org.openecomp.aai.annotations.Metadata(description="password used to access external systems.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.") - + - @org.openecomp.aai.annotations.Metadata(description="authentication url of the cloud.") + @org.openecomp.aai.annotations.Metadata(description="protocol of third party SDNC, for example netconf/snmp.") @@ -1776,19 +1811,75 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + @org.openecomp.aai.annotations.Metadata(description="service IP of ftp server.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="service port of ftp server.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="domain info for authentication.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="default tenant of VIM.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="ftp passive mode or not.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="resource or performance data file path.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="the status of external system.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + - + - @org.openecomp.aai.annotations.Metadata(description="Collection of persistent auth information to access to VIM.") + @org.openecomp.aai.annotations.Metadata(description="Collection of persistent block-level external system auth info.") - + @@ -1894,7 +1985,7 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" - + @@ -2057,6 +2148,13 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + @org.openecomp.aai.annotations.Metadata(description="MAC Address of the p-interface.") + + + @@ -2460,6 +2558,165 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + + @org.openecomp.aai.annotations.Metadata(description="Persist EMS address information used by EMS driver.",indexedProps="ems-id",searchable="ems-id",container="esr-ems-list",namespace="external-system") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Unique ID of EMS.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(maximumDepth="0") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Persist VNFM address information used by VF-C.",indexedProps="vnfm-id",searchable="vnfm-id",container="esr-vnfm-list",namespace="external-system") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Unique ID of VNFM.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="indecate the VIM to deploy VNF.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="certificate url of VNFM.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(maximumDepth="0") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Persist SDNC address information used by ONAP SDNC.",indexedProps="sdnc-id",searchable="sdnc-id",container="esr-thirdparty-sdnc-list",namespace="external-system") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Unique ID of SDNC.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="used for DC type to indicate the location of SDNC, such as Core or Edge.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="password used to access SDNC server.") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(maximumDepth="0") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Namespace for external system.") + + + + + + + + + @@ -2974,6 +3231,165 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + + @org.openecomp.aai.annotations.Metadata(description="describes a line-of-business",indexedProps="line-of-business-name",uniqueProps="line-of-business-name",container="lines-of-business",namespace="business") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Name of the line-of-business (product)") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Collection of lines-of-business") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="describes an owning-entity",indexedProps="owning-entity-id, owning-entity-name",searchable="owning-entity-id",uniqueProps="owning-entity-id, owning-entity-name",container="owning-entities",namespace="business") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="UUID of an owning entity") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Owning entity name") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Collection of owning-entities") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="describes a platform",indexedProps="platform-name",uniqueProps="platform-name",container="platforms",namespace="business") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Name of the platform") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Collection of platforms") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="describes the project",indexedProps="project-name",uniqueProps="project-name",container="projects",namespace="business") + + + + + + + @org.openecomp.aai.annotations.Metadata(isKey=true,description="Name of the project deploying a service") + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Used for optimistic concurrency. Must be empty on create, valid on update and delete.") + + + + + + + + + + + + @org.openecomp.aai.annotations.Metadata(description="Collection of projects") + + + + + + + @@ -2984,6 +3400,10 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + + + + @@ -6773,6 +7193,7 @@ xmlns:jaxb="http://java.sun.com/xml/ns/jaxb" + 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 bd2e18aa..f30983e9 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 @@ -67,36 +67,6 @@ 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}

delete an existing cloud-region

- - - - GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items -

returns auth-info-items

- - - - GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id} -

returns auth-info-item

- - - - PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id} -

create or update an existing auth-info-item

- - - - DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id} -

delete an existing auth-info-item

- - - - PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}/relationship-list/relationship -

see node definition for valid relationships

- - - - DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}/relationship-list/relationship -

delete an existing relationship

@@ -157,6 +127,36 @@ 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}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

delete an existing relationship

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

returns esr-system-info-list

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

returns esr-system-info

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

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

delete an existing esr-system-info

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

see node definition for valid relationships

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

delete an existing relationship

@@ -1273,6 +1273,200 @@ 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

@@ -1501,6 +1695,126 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -2649,6 +2963,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + @@ -3829,6 +4173,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3849,6 +4243,56 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -11119,17 +11563,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns cloud-regions
-

GET /cloud-infrastructure/cloud-regions

+
returns lines-of-business
+

GET /business/lines-of-business

Tags: - CloudInfrastructure + Business
-

returns cloud-regions

+

returns lines-of-business

@@ -11155,7 +11599,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cloud-regions + /lines-of-business
@@ -11183,17 +11627,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns cloud-region
-

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

+
returns line-of-business
+

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

Tags: - CloudInfrastructure + Business
-

returns cloud-region

+

returns line-of-business

@@ -11210,10 +11654,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
DELETE /business/customers/customer/{global-customer-id}/service-subscriptions/service-subscription/{service-type}/service-instances/service-instance/{service-instance-id}/relationship-list/relationship

delete an existing relationship

+
GET /business/lines-of-business

returns lines-of-business

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

returns line-of-business

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

create or update an existing line-of-business

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

delete an existing line-of-business

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /business/owning-entities

returns owning-entities

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

returns owning-entity

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

create or update an existing owning-entity

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

delete an existing owning-entity

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /business/platforms

returns platforms

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

returns platform

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

create or update an existing platform

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

delete an existing platform

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

see node definition for valid relationships

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

delete an existing relationship

+
GET /business/projects

returns projects

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

returns project

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

create or update an existing project

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

delete an existing project

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

see node definition for valid relationships

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

delete an existing relationship
DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

delete an existing subnet

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

returns host-routes

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

returns host-route

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

create or update an existing host-route

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

delete an existing host-route

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

see node definition for valid relationships

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

delete an existing relationship
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
DELETE /network/vnfcs/vnfc/{vnfc-name}

delete an existing vnfc

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

returns l3-interface-ipv4-address-list

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

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

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

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

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

see node definition for valid relationships

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

delete an existing relationship

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

returns l3-interface-ipv6-address-list

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

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

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

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

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

see node definition for valid relationships

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

delete an existing relationship
- cloud-owner + line-of-business-name -

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

+

Name of the line-of-business (product)

 path @@ -11224,12 +11668,108 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /line-of-business +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+ + + + +
+
+
create or update an existing line-of-business
+

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

+ Tags: + Business +
+
+
+

create or update an existing line-of-business

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /line-of-business +
+
+
+
+
+ + + + + + + + + + + + +
- cloud-region-id + line-of-business-name -

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

+

Name of the line-of-business (product)

 path @@ -11240,27 +11780,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 line-of-business
+

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

+ Tags: + Business +
+
+
+

delete an existing line-of-business

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /cloud-region -
-
-
- -
default @@ -11324,17 +11904,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing cloud-region
-

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

+
see node definition for valid relationships
+

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

Tags: - CloudInfrastructure + Business
-

create or update an existing cloud-region

+

see node definition for valid relationships

@@ -11343,13 +11923,13 @@ 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

+

relationship object that needs to be created or updated

- /cloud-region + /relationship
@@ -11368,26 +11948,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- cloud-type + line-of-business-name -

Type of the cloud (e.g., openstack)

+

Name of the line-of-business (product)

querypath string +
- owner-defined-type + resource-version -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

resource-version for concurrency

 query @@ -11268,6 +11870,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- cloud-owner - -

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

- 		path - string - - - -
- cloud-region-id + line-of-business-name -

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

+

Name of the line-of-business (product)

 path @@ -11429,17 +11993,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing cloud-region
-

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

+
delete an existing relationship
+

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

Tags: - CloudInfrastructure + Business
-

delete an existing cloud-region

+

delete an existing relationship

@@ -11461,26 +12025,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner - -

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

- 		path - string - - - -
- cloud-region-id + line-of-business-name -

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

+

Name of the line-of-business (product)

 path @@ -11491,22 +12039,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -11538,96 +12070,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns auth-info-items
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items

+
returns owning-entities
+

GET /business/owning-entities

Tags: - CloudInfrastructure + Business
-

returns auth-info-items

+

returns owning-entities

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

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

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

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

- 		path - string - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- 		query - string - - -
-

application/json application/xml @@ -11651,7 +12106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /auth-info-items + /owning-entities
@@ -11679,17 +12134,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns auth-info-item
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}

+
returns owning-entity
+

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

Tags: - CloudInfrastructure + Business
-

returns auth-info-item

+

returns owning-entity

@@ -11706,42 +12161,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 - - - - - - - - - auth-info-item-id + owning-entity-id -

Unique ID of auth-info-item.

+

UUID of an owning entity

path @@ -11752,66 +12175,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 - - - - - - - - username - - -

user name of auth infomation to access VIM.

- - query - - string - - - - - - - - auth-url - - -

authentication url of the cloud.

- - query - - string - - - - -
@@ -11838,7 +12201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /auth-info-item + /owning-entity
@@ -11866,17 +12229,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing auth-info-item
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}

+
create or update an existing owning-entity
+

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

Tags: - CloudInfrastructure + Business
-

create or update an existing auth-info-item

+

create or update an existing owning-entity

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

-

auth-info-item object that needs to be created or updated

+

owning-entity object that needs to be created or updated

- /auth-info-item + /owning-entity
@@ -11910,42 +12273,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 - - - - - - - - - auth-info-item-id + owning-entity-id -

Unique ID of auth-info-item.

+

UUID of an owning entity

path @@ -11987,17 +12318,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing auth-info-item
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/auth-info-items/auth-info-item/{auth-info-item-id}

+
delete an existing owning-entity
+

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

Tags: - CloudInfrastructure + Business
-

delete an existing auth-info-item

+

delete an existing owning-entity

@@ -12019,42 +12350,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 - - - - - - - - - auth-info-item-id + owning-entity-id -

Unique ID of auth-info-item.

+

UUID of an owning entity

path @@ -12112,13 +12411,13 @@ 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}/auth-info-items/auth-info-item/{auth-info-item-id}/relationship-list/relationship

+

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

Tags: - CloudInfrastructure + Business
@@ -12156,42 +12455,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 - - - - - - - - - auth-info-item-id + owning-entity-id -

Unique ID of auth-info-item.

+

UUID of an owning entity

path @@ -12233,13 +12500,13 @@ 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}/auth-info-items/auth-info-item/{auth-info-item-id}/relationship-list/relationship

+

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

Tags: - CloudInfrastructure + Business
@@ -12265,42 +12532,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 - - - - - - - - - auth-info-item-id + owning-entity-id -

Unique ID of auth-info-item.

+

UUID of an owning entity

path @@ -12342,96 +12577,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns availability-zones
-

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

+
returns platforms
+

GET /business/platforms

Tags: - CloudInfrastructure + Business
-

returns availability-zones

+

returns platforms

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

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

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

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

- 		path - string - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- 		query - string - - -
-

application/json application/xml @@ -12455,7 +12613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /availability-zones + /platforms
@@ -12483,17 +12641,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns availability-zone
-

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

+
returns platform
+

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

Tags: - CloudInfrastructure + Business
-

returns availability-zone

+

returns platform

@@ -12510,42 +12668,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + platform-name -

Name of the availability zone. Unique across a cloud region

+

Name of the platform

path @@ -12556,36 +12682,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 - - - - -
@@ -12612,7 +12708,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /availability-zone + /platform
@@ -12640,17 +12736,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing availability-zone
-

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

+
create or update an existing platform
+

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

Tags: - CloudInfrastructure + Business
-

create or update an existing availability-zone

+

create or update an existing platform

@@ -12659,13 +12755,13 @@ 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

+

platform object that needs to be created or updated

- /availability-zone + /platform
@@ -12684,42 +12780,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + platform-name -

Name of the availability zone. Unique across a cloud region

+

Name of the platform

path @@ -12761,17 +12825,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing availability-zone
-

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

+
delete an existing platform
+

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

Tags: - CloudInfrastructure + Business
-

delete an existing availability-zone

+

delete an existing platform

@@ -12793,42 +12857,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + platform-name -

Name of the availability zone. Unique across a cloud region

+

Name of the platform

path @@ -12886,13 +12918,13 @@ 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}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

+

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

Tags: - CloudInfrastructure + Business
@@ -12930,42 +12962,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + platform-name -

Name of the availability zone. Unique across a cloud region

+

Name of the platform

path @@ -13007,13 +13007,13 @@ 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}/availability-zones/availability-zone/{availability-zone-name}/relationship-list/relationship

+

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

Tags: - CloudInfrastructure + Business
@@ -13039,42 +13039,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + platform-name -

Name of the availability zone. Unique across a cloud region

+

Name of the platform

path @@ -13116,96 +13084,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns dvs-switches
-

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

+
returns projects
+

GET /business/projects

Tags: - CloudInfrastructure + Business
-

returns dvs-switches

+

returns projects

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

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

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

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

- 		path - string - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- 		query - string - - -
-

application/json application/xml @@ -13229,7 +13120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /dvs-switches + /projects
@@ -13257,17 +13148,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns dvs-switch
-

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

+
returns project
+

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

Tags: - CloudInfrastructure + Business
-

returns dvs-switch

+

returns project

@@ -13284,42 +13175,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + project-name -

DVS switch name

+

Name of the project deploying a service

path @@ -13330,51 +13189,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 - - - - - - - - vcenter-url - - -

URL used to reach the vcenter

- - query - - string - - - - -
@@ -13401,7 +13215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /dvs-switch + /project
@@ -13429,17 +13243,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing dvs-switch
-

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

+
create or update an existing project
+

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

Tags: - CloudInfrastructure + Business
-

create or update an existing dvs-switch

+

create or update an existing project

@@ -13448,13 +13262,13 @@ 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

+

project object that needs to be created or updated

- /dvs-switch + /project
@@ -13473,42 +13287,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + project-name -

DVS switch name

+

Name of the project deploying a service

path @@ -13550,17 +13332,17 @@ 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}

+
delete an existing project
+

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

Tags: - CloudInfrastructure + Business
-

delete an existing dvs-switch

+

delete an existing project

@@ -13582,42 +13364,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + project-name -

DVS switch name

+

Name of the project deploying a service

path @@ -13675,13 +13425,13 @@ 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

+

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

Tags: - CloudInfrastructure + Business
@@ -13719,42 +13469,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + project-name -

DVS switch name

+

Name of the project deploying a service

path @@ -13796,13 +13514,13 @@ 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}/dvs-switches/dvs-switch/{switch-name}/relationship-list/relationship

+

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

Tags: - CloudInfrastructure + Business
@@ -13828,42 +13546,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-owner - - -

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

- - path - - string - - - - - - - - - cloud-region-id + project-name -

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

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

DVS switch name

+

Name of the project deploying a service

path @@ -13905,96 +13591,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns flavors
-

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

+
returns cloud-regions
+

GET /cloud-infrastructure/cloud-regions

Tags: CloudInfrastructure
-

returns flavors

+

returns cloud-regions

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

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

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

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

- 		path - string - - - -
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type - -

Cloud-owner defined type indicator (e.g., dcp, lcp)

- 		query - string - - -
-

application/json application/xml @@ -14018,7 +13627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /flavors + /cloud-regions
@@ -14046,17 +13655,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns flavor
-

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

+
returns cloud-region
+

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

Tags: CloudInfrastructure
-

returns flavor

+

returns cloud-region

@@ -14103,22 +13712,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - flavor-id - - -

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

- - path - - string - - - - - - cloud-type @@ -14149,21 +13742,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - flavor-name - - -

Flavor name

- - query - - string - - - - -
@@ -14190,7 +13768,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /flavor + /cloud-region
@@ -14218,17 +13796,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing flavor
-

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

+
create or update an existing cloud-region
+

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

Tags: CloudInfrastructure
-

create or update an existing flavor

+

create or update an existing cloud-region

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

-

flavor object that needs to be created or updated

+

cloud-region object that needs to be created or updated

- /flavor + /cloud-region
@@ -14292,22 +13870,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - flavor-id - - -

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

- - path - - string - - - - - -
@@ -14339,17 +13901,17 @@ 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}

+
delete an existing cloud-region
+

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

Tags: CloudInfrastructure
-

delete an existing flavor

+

delete an existing cloud-region

@@ -14401,22 +13963,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - flavor-id - - -

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

- - path - - string - - - - - - resource-version @@ -14464,36 +14010,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/relationship-list/relationship

+
returns availability-zones
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns availability-zones

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -14540,18 +14069,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -14563,6 +14106,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /availability-zones +
+
+
+ +
default @@ -14585,24 +14151,19 @@ 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}/flavors/flavor/{flavor-id}/relationship-list/relationship

+
returns availability-zone
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns availability-zone

-
- -

application/json application/xml -

-
- flavor-id + cloud-type -

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

+

Type of the cloud (e.g., openstack)

pathquery + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query string -
@@ -14649,10 +14210,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + +
- flavor-id + availability-zone-name -

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

+

Name of the availability zone. Unique across a cloud region

 path @@ -14663,6 +14224,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 + + +
@@ -14672,6 +14263,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /availability-zone +
+
+
+ +
default @@ -14694,19 +14308,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns group-assignments
-

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

+
create or update an existing availability-zone
+

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

Tags: CloudInfrastructure
-

returns group-assignments

+

create or update an existing availability-zone

+
+ +

application/json application/xml +

+
+
+

availability-zone object that needs to be created or updated

+

+
+
+
+
+ /availability-zone +
+
+
+
@@ -14753,32 +14384,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -14790,29 +14407,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /group-assignments -
-
-
- -
default @@ -14835,19 +14429,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns group-assignment
-

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

+
delete an existing availability-zone
+

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

Tags: CloudInfrastructure
-

returns group-assignment

+

delete an existing availability-zone

+
+ +

application/json application/xml +

+
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type + availability-zone-name -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Name of the availability zone. Unique across a cloud region

querypath string +
@@ -14894,10 +14493,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - @@ -14977,29 +14532,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /group-assignment -
-
-
- -
default @@ -15022,17 +14554,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing group-assignment
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

create or update an existing group-assignment

+

see node definition for valid relationships

@@ -15041,13 +14573,13 @@ 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

+

relationship object that needs to be created or updated

- /group-assignment + /relationship
@@ -15098,10 +14630,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- group-id + availability-zone-name -

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

+

Name of the availability zone. Unique across a cloud region

 path @@ -14910,55 +14509,10 @@ 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 - - -
- group-type - -

Group type - the type of group this instance refers to

- 		query - string - - -
- group-name + resource-version -

Group name - name assigned to the group

+

resource-version for concurrency

 query @@ -14966,6 +14520,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- group-id + availability-zone-name -

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

+

Name of the availability zone. Unique across a cloud region

 path @@ -15143,17 +14675,17 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

delete an existing group-assignment

+

delete an existing relationship

@@ -15207,10 +14739,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- group-id + availability-zone-name -

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

+

Name of the availability zone. Unique across a cloud region

 path @@ -15221,22 +14753,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -15268,36 +14784,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+
returns dvs-switches
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns dvs-switches

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -15344,18 +14843,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -15367,6 +14880,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /dvs-switches +
+
+
+ +
default @@ -15389,24 +14925,19 @@ 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}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

+
returns dvs-switch
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns dvs-switch

-
- -

application/json application/xml -

-
- group-id + cloud-type -

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

+

Type of the cloud (e.g., openstack)

pathquery + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query string -
@@ -15453,82 +14984,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- group-id - -

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

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns images
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns images

- -
-
- - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner + switch-name -

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

+

DVS switch name

 path @@ -15541,26 +15000,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + cloud-type -

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

+

Type of the cloud (e.g., openstack)

pathquery string -
- cloud-type + owner-defined-type -

Type of the cloud (e.g., openstack)

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -15572,10 +15030,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + vcenter-url -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

URL used to reach the vcenter

 query @@ -15611,7 +15069,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /images + /dvs-switch
@@ -15639,19 +15097,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns image
-

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

+
create or update an existing dvs-switch
+

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

Tags: CloudInfrastructure
-

returns image

+

create or update an existing dvs-switch

+
+ +

application/json application/xml +

+
+
+

dvs-switch object that needs to be created or updated

+

+
+
+
+
+ /dvs-switch +
+
+
+
@@ -15698,10 +15173,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- image-id + switch-name -

Image id, expected to be unique across cloud region

+

DVS switch name

 path @@ -15712,87 +15187,121 @@ 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 dvs-switch
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing dvs-switch

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /image -
-
-
- -
default @@ -15856,17 +15343,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing image
-

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

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

create or update an existing image

+

see node definition for valid relationships

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

-

image object that needs to be created or updated

+

relationship object that needs to be created or updated

- /image + /relationship
@@ -15932,10 +15419,10 @@ 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 - - -
- image-name + cloud-owner -

Image name

+

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

querypath string +
- application + cloud-region-id -

The application that the image instantiates.

+

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

querypath string +
- application-vendor + switch-name -

The vendor of the application.

+

DVS switch name

querypath string +
- application-version + resource-version -

The version of the application.

+

resource-version for concurrency

 query @@ -15800,6 +15309,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- image-id + switch-name -

Image id, expected to be unique across cloud region

+

DVS switch name

 path @@ -15977,17 +15464,17 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

delete an existing image

+

delete an existing relationship

@@ -16041,10 +15528,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- image-id + switch-name -

Image id, expected to be unique across cloud region

+

DVS switch name

 path @@ -16055,22 +15542,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -16102,17 +15573,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns metadata
-

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

+
returns esr-system-info-list
+

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

Tags: CloudInfrastructure
-

returns metadata

+

returns esr-system-info-list

@@ -16159,22 +15630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- image-id - -

Image id, expected to be unique across cloud region

- 		path - string - - - -
cloud-type @@ -16205,66 +15660,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- image-name - -

Image name

- 		query - string - - -
- application - -

The application that the image instantiates.

- 		query - string - - -
- application-vendor - -

The vendor of the application.

- 		query - string - - -
- application-version - -

The version of the application.

- 		query - string - - -
@@ -16291,7 +15686,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadata + /esr-system-info-list
@@ -16319,17 +15714,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns metadatum
-

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

+
returns esr-system-info
+

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

Tags: CloudInfrastructure
-

returns metadatum

+

returns esr-system-info

@@ -16378,25 +15773,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - image-id - - -

Image id, expected to be unique across cloud region

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

Unique ID of esr system info.

path @@ -16439,25 +15819,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - image-name - - -

Image name

- - query - - string - - - - - - - - application + system-name -

The application that the image instantiates.

+

name of external system.

query @@ -16469,25 +15834,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - application-vendor + system-type -

The vendor of the application.

- - query - - string - - - - - - - - application-version - - -

The version of the application.

+

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

query @@ -16523,7 +15873,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /metadatum + /esr-system-info
@@ -16551,17 +15901,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing metadatum
-

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

+
create or update an existing esr-system-info
+

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

Tags: CloudInfrastructure
-

create or update an existing metadatum

+

create or update an existing esr-system-info

@@ -16570,13 +15920,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

+

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

- /metadatum + /esr-system-info
@@ -16627,25 +15977,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - image-id - - -

Image id, expected to be unique across cloud region

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

Unique ID of esr system info.

path @@ -16687,17 +16022,17 @@ 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}

+
delete an existing esr-system-info
+

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

Tags: CloudInfrastructure
-

delete an existing metadatum

+

delete an existing esr-system-info

@@ -16751,25 +16086,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - image-id - - -

Image id, expected to be unique across cloud region

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

Unique ID of esr system info.

path @@ -16827,11 +16147,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/images/image/{image-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -16903,10 +16223,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - image-id + esr-system-info-id -

Image id, expected to be unique across cloud region

+

Unique ID of esr system info.

path @@ -16948,11 +16268,11 @@ 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}/images/image/{image-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -17012,10 +16332,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - image-id + esr-system-info-id -

Image id, expected to be unique across cloud region

+

Unique ID of esr system info.

path @@ -17057,17 +16377,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns oam-networks
-

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

+
returns flavors
+

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

Tags: CloudInfrastructure
-

returns oam-networks

+

returns flavors

@@ -17170,7 +16490,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /oam-networks + /flavors
@@ -17198,17 +16518,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns oam-network
-

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

+
returns flavor
+

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

Tags: CloudInfrastructure
-

returns oam-network

+

returns flavor

@@ -17257,10 +16577,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-uuid + flavor-id -

UUID of the network. Unique across a cloud-region

+

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

path @@ -17303,10 +16623,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name + flavor-name -

Name of the network.

+

Flavor name

query @@ -17316,21 +16636,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cvlan-tag - - -

cvlan-id

- - query - - integer - - - - -
@@ -17357,7 +16662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /oam-network + /flavor
@@ -17385,17 +16690,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing oam-network
-

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

+
create or update an existing flavor
+

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

Tags: CloudInfrastructure
-

create or update an existing oam-network

+

create or update an existing flavor

@@ -17404,13 +16709,13 @@ 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

+

flavor object that needs to be created or updated

- /oam-network + /flavor
@@ -17461,10 +16766,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-uuid + flavor-id -

UUID of the network. Unique across a cloud-region

+

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

path @@ -17506,17 +16811,17 @@ 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}

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

+

delete an existing flavor

@@ -17570,10 +16875,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-uuid + flavor-id -

UUID of the network. Unique across a cloud-region

+

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

path @@ -17631,11 +16936,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -17707,10 +17012,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-uuid + flavor-id -

UUID of the network. Unique across a cloud-region

+

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

path @@ -17752,11 +17057,11 @@ 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}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -17816,10 +17121,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-uuid + flavor-id -

UUID of the network. Unique across a cloud-region

+

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

path @@ -17861,36 +17166,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/relationship-list/relationship

+
returns group-assignments
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns group-assignments

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -17935,6 +17223,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 + + +
@@ -17944,6 +17262,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /group-assignments +
+
+
+ +
default @@ -17966,24 +17307,19 @@ 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}/relationship-list/relationship

+
returns group-assignment
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns group-assignment

-
- -

application/json application/xml -

-
@@ -18028,6 +17364,82 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ group-id + +

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

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ group-type + +

Group type - the type of group this instance refers to

+ 		query + string + + +
+ group-name + +

Group name - name assigned to the group

+ 		query + string + + +
@@ -18037,6 +17449,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /group-assignment +
+
+
+ +
default @@ -18059,19 +17494,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns snapshots
-

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

+
create or update an existing group-assignment
+

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

Tags: CloudInfrastructure
-

returns snapshots

+

create or update an existing group-assignment

+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be created or updated

+

+
+
+
+
+ /group-assignment +
+
+
+
@@ -18118,32 +17570,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -18155,29 +17593,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /snapshots -
-
-
- -
default @@ -18200,19 +17615,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns snapshot
-

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

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

returns snapshot

+

delete an existing group-assignment

+
+ +

application/json application/xml +

+
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type + group-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

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

querypath string +
@@ -18259,10 +17679,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -18387,29 +17718,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /snapshot -
-
-
- -
default @@ -18432,17 +17740,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing snapshot
-

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

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

create or update an existing snapshot

+

see node definition for valid relationships

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

-

snapshot object that needs to be created or updated

+

relationship object that needs to be created or updated

- /snapshot + /relationship
@@ -18508,10 +17816,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - -
- snapshot-id + group-id -

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

+

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

 path @@ -18275,100 +17695,10 @@ 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 - - -
- snapshot-name - -

Snapshot name

- 		query - string - - -
- application - -

The application that the image instantiates.

- 		query - string - - -
- application-vendor - -

The vendor of the application.

- 		query - string - - -
- application-version - -

The version of the application.

- 		query - string - - -
- prev-snapshot-id + resource-version -

This field contains the UUID of the previous snapshot (if any).

+

resource-version for concurrency

 query @@ -18376,6 +17706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- snapshot-id + group-id -

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

+

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

 path @@ -18553,17 +17861,17 @@ 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}

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

+

delete an existing relationship

@@ -18617,10 +17925,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- snapshot-id + group-id -

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

+

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

 path @@ -18631,22 +17939,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -18678,36 +17970,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

+
returns images
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns images

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -18754,18 +18029,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + @@ -18777,6 +18066,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /images +
+
+
+ +
default @@ -18799,24 +18111,19 @@ 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

+
returns image
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns image

-
- -

application/json application/xml -

-
- snapshot-id + cloud-type -

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

+

Type of the cloud (e.g., openstack)

pathquery + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query string -
@@ -18863,10 +18170,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- snapshot-id + image-id -

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

+

Image id, expected to be unique across cloud region

 path @@ -18877,6 +18184,96 @@ 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 + + +
+ image-name + +

Image name

+ 		query + string + + +
+ application + +

The application that the image instantiates.

+ 		query + string + + +
+ application-vendor + +

The vendor of the application.

+ 		query + string + + +
+ application-version + +

The version of the application.

+ 		query + string + + +
@@ -18886,6 +18283,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /image +
+
+
+ +
default @@ -18908,17 +18328,263 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns tenants
-

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

+
create or update an existing image
+

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

Tags: CloudInfrastructure
-

returns tenants

+

create or update an existing image

+ +
+
+ +

application/json application/xml +

+
+
+

image object that needs to be created or updated

+

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

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

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

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

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

Image id, expected to be unique across cloud region

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing image

+ +
+
+ +

application/json application/xml +

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

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

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

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

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

Image id, expected to be unique across cloud region

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadata
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns metadata

@@ -18965,6 +18631,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + image-id + + +

Image id, expected to be unique across cloud region

+ + path + + string + + + + + + cloud-type @@ -18995,6 +18677,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + image-name + + +

Image name

+ + query + + string + + + + + + + + application + + +

The application that the image instantiates.

+ + query + + string + + + + + + + + application-vendor + + +

The vendor of the application.

+ + query + + string + + + + + + + + application-version + + +

The version of the application.

+ + query + + string + + + + +
@@ -19021,7 +18763,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tenants + /metadata
@@ -19049,17 +18791,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns tenant
-

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

+
returns metadatum
+

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

Tags: CloudInfrastructure
-

returns tenant

+

returns metadatum

@@ -19108,10 +18850,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id + image-id + + +

Image id, expected to be unique across cloud region

+ + path + + string + + + + + + + + + metaname -

Unique id relative to the cloud-region.

path @@ -19154,10 +18911,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-name + image-name -

Readable name of tenant

+

Image name

query @@ -19169,10 +18926,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-context + application -

This field will store the tenant context.

+

The application that the image instantiates.

+ + query + + string + + + + + + + + application-vendor + + +

The vendor of the application.

+ + query + + string + + + + + + + + application-version + + +

The version of the application.

query @@ -19208,7 +18995,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /tenant + /metadatum
@@ -19236,17 +19023,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing tenant
-

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

+
create or update an existing metadatum
+

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

Tags: CloudInfrastructure
-

create or update an existing tenant

+

create or update an existing metadatum

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

-

tenant object that needs to be created or updated

+

metadatum object that needs to be created or updated

- /tenant + /metadatum
@@ -19312,10 +19099,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id + image-id + + +

Image id, expected to be unique across cloud region

+ + path + + string + + + + + + + + + metaname -

Unique id relative to the cloud-region.

path @@ -19357,17 +19159,17 @@ 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}

+
delete an existing metadatum
+

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

Tags: CloudInfrastructure
-

delete an existing tenant

+

delete an existing metadatum

@@ -19421,10 +19223,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id + image-id + + +

Image id, expected to be unique across cloud region

+ + path + + string + + + + + + + + + metaname -

Unique id relative to the cloud-region.

path @@ -19482,11 +19299,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -19558,10 +19375,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id + image-id -

Unique id relative to the cloud-region.

+

Image id, expected to be unique across cloud region

path @@ -19603,11 +19420,11 @@ 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

+

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

Tags: CloudInfrastructure
@@ -19667,10 +19484,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id + image-id -

Unique id relative to the cloud-region.

+

Image id, expected to be unique across cloud region

path @@ -19712,17 +19529,17 @@ 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

+
returns oam-networks
+

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

Tags: CloudInfrastructure
-

returns vservers

+

returns oam-networks

@@ -19769,22 +19586,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - tenant-id - - -

Unique id relative to the cloud-region.

- - path - - string - - - - - - cloud-type @@ -19815,36 +19616,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - tenant-name - - -

Readable name of tenant

- - query - - string - - - - - - - - tenant-context - - -

This field will store the tenant context.

- - query - - string - - - - -
@@ -19871,7 +19642,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vservers + /oam-networks
@@ -19899,17 +19670,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 oam-network
+

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

Tags: CloudInfrastructure
-

returns vserver

+

returns oam-network

@@ -19958,26 +19729,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id - - -

Unique id relative to the cloud-region.

- - path - - string - - - - - - - - - vserver-id + network-uuid -

Unique identifier for this vserver relative to its tenant

+

UUID of the network. Unique across a cloud-region

path @@ -20020,70 +19775,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - 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 + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name of the network.

query @@ -20095,27 +19790,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled + cvlan-tag +

cvlan-id

query - boolean + integer @@ -20147,7 +19829,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vserver + /oam-network
@@ -20175,17 +19857,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing vserver
-

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

+
create or update an existing oam-network
+

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

Tags: CloudInfrastructure
-

create or update an existing vserver

+

create or update an existing oam-network

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

-

vserver object that needs to be created or updated

+

oam-network object that needs to be created or updated

- /vserver + /oam-network
@@ -20251,26 +19933,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id - - -

Unique id relative to the cloud-region.

- - path - - string - - - - - - - - - vserver-id + network-uuid -

Unique identifier for this vserver relative to its tenant

+

UUID of the network. Unique across a cloud-region

path @@ -20312,17 +19978,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vserver
-

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

+
delete an existing 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 vserver

+

delete an existing oam-network

@@ -20376,26 +20042,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-id - - -

Unique id relative to the cloud-region.

- - path - - string - - - - - - - - - vserver-id + network-uuid -

Unique identifier for this vserver relative to its tenant

+

UUID of the network. Unique across a cloud-region

path @@ -20453,19 +20103,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l-interfaces
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -20512,10 +20179,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- tenant-id + network-uuid -

Unique id relative to the cloud-region.

+

UUID of the network. Unique across a cloud-region

 path @@ -20526,12 +20193,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + +
- vserver-id + cloud-owner -

Unique identifier for this vserver relative to its tenant

+

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

 path @@ -20544,118 +20272,332 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type + cloud-region-id -

Type of the cloud (e.g., openstack)

+

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

querypath string +
- owner-defined-type + network-uuid -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

UUID of the network. Unique across a cloud-region

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + + +
- tenant-name + cloud-owner -

Readable name of tenant

+

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

querypath string +
- tenant-context + cloud-region-id -

This field will store the tenant context.

+

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

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + + + + + +
- vserver-name + cloud-owner -

Name of vserver

+

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

querypath string +
- vserver-name2 + cloud-region-id -

Alternative name of vserver

+

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

querypath + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns snapshots
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns snapshots

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

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

+ 		path string +
- prov-status + cloud-region-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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

querypath string +
- in-maint + cloud-type +

Type of the cloud (e.g., openstack)

 query - boolean + string @@ -20663,13 +20605,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + owner-defined-type +

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query - boolean + string @@ -20701,7 +20644,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /snapshots
@@ -20729,17 +20672,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l-interface
-

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

+
returns snapshot
+

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

Tags: CloudInfrastructure
-

returns l-interface

+

returns snapshot

@@ -20788,42 +20731,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + snapshot-id -

Name given to the interface

+

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

 path @@ -20866,55 +20777,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + snapshot-name -

Alternative name of vserver

+

Snapshot name

 query @@ -20926,10 +20792,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + application -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

The application that the image instantiates.

 query @@ -20941,38 +20807,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + application-vendor -

ID of interface

+

The vendor of the application.

 query @@ -20984,10 +20822,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + application-version -

MAC address for the interface

+

The version of the application.

 query @@ -20999,10 +20837,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + prev-snapshot-id -

Name of the network

+

This field contains the UUID of the previous snapshot (if any).

 query @@ -21038,7 +20876,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /snapshot
@@ -21066,17 +20904,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/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 snapshot
+

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

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

create or update an existing snapshot

@@ -21085,13 +20923,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

+

snapshot object that needs to be created or updated

- /l-interface + /snapshot
@@ -21142,42 +20980,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + snapshot-id -

Name given to the interface

+

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

 path @@ -21219,17 +21025,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l-interface
-

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

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

+

delete an existing snapshot

@@ -21283,42 +21089,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- 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 + snapshot-id -

Name given to the interface

+

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

 path @@ -21376,19 +21150,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/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}

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

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -21435,10 +21226,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- tenant-id + snapshot-id -

Unique id relative to the cloud-region.

+

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

 path @@ -21449,12 +21240,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/snapshots/snapshot/{snapshot-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + +
- vserver-id + cloud-owner -

Unique identifier for this vserver relative to its tenant

+

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

 path @@ -21467,10 +21319,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + cloud-region-id -

Name given to the interface

+

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

 path @@ -21483,10 +21335,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + snapshot-id -

IP address

+

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

 path @@ -21497,57 +21349,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 tenants
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns tenants

+ +
+
+ + + + + + + + + + + - - - - - - - - + - + + +
- cloud-type - -

Type of the cloud (e.g., openstack)

- 		query - string - - -
- owner-defined-type + cloud-owner -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

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

querypath string +
- tenant-name + cloud-region-id -

Readable name of tenant

+

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

querypath string +
- tenant-context + cloud-type -

This field will store the tenant context.

+

Type of the cloud (e.g., openstack)

 query @@ -21559,10 +21454,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-name + owner-defined-type -

Name of vserver

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -21572,85 +21467,139 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /tenants +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns tenant
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns tenant

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vserver-name2 + cloud-owner -

Alternative name of vserver

+

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

querypath string +
- prov-status + cloud-region-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + tenant-id -

ID of interface

+

Unique id relative to the cloud-region.

querypath string +
- macaddr + cloud-type -

MAC address for the interface

+

Type of the cloud (e.g., openstack)

 query @@ -21662,10 +21611,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + owner-defined-type -

Name of the network

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -21677,25 +21626,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 + tenant-name -

Neutron network id of the interface that address belongs to

+

Readable name of tenant

 query @@ -21707,10 +21641,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + tenant-context -

Neutron id of subnet that address belongs to

+

This field will store the tenant context.

 query @@ -21746,7 +21680,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /tenant
@@ -21774,17 +21708,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/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 tenant
+

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

Tags: CloudInfrastructure
-

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

+

create or update an existing tenant

@@ -21793,13 +21727,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

+

tenant object that needs to be created or updated

- /l3-interface-ipv4-address-list + /tenant
@@ -21864,54 +21798,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 - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -21943,17 +21829,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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing tenant
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing tenant

@@ -22021,54 +21907,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 - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
resource-version @@ -22116,11 +21954,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -22206,54 +22044,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 - - - -
- interface-name - -

Name given to the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -22285,11 +22075,11 @@ 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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -22363,54 +22153,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 - - - - - - - - - interface-name - - -

Name given to the interface

- - path - - string - - - - - - - - - l3-interface-ipv4-address - - -

IP address

- - path - - string - - - - - - @@ -22442,17 +22184,17 @@ 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns vservers
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

returns vservers

@@ -22517,58 +22259,40 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vserver-id + cloud-type -

Unique identifier for this vserver relative to its tenant

+

Type of the cloud (e.g., openstack)

- path + query string - - interface-name + owner-defined-type -

Name given to the interface

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

- path + query string - - - - - - l3-interface-ipv6-address - - -

IP address

- - path - - string - - - - - cloud-type + tenant-name -

Type of the cloud (e.g., openstack)

+

Readable name of tenant

query @@ -22580,10 +22304,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + tenant-context -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

This field will store the tenant context.

query @@ -22593,72 +22317,155 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vservers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vserver
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vserver

+ +
+
+ + + + + + + + + + + - + - + - + - + - - - - - - - - - - - - - -
- tenant-name + cloud-owner -

Readable name of tenant

+

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

querypath string +
- tenant-context + cloud-region-id -

This field will store the tenant context.

+

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

querypath string +
- vserver-name + tenant-id -

Name of vserver

+

Unique id relative to the cloud-region.

querypath string +
- vserver-name2 + vserver-id -

Alternative name of vserver

+

Unique identifier for this vserver relative to its tenant

querypath string +
- prov-status + cloud-type -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Type of the cloud (e.g., openstack)

 query @@ -22670,13 +22477,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + owner-defined-type +

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query - boolean + string @@ -22684,13 +22492,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + tenant-name +

Readable name of tenant

 query - boolean + string @@ -22698,10 +22507,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + tenant-context -

ID of interface

+

This field will store the tenant context.

 query @@ -22713,10 +22522,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vserver-name -

MAC address for the interface

+

Name of vserver

 query @@ -22728,10 +22537,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vserver-name2 -

Name of the network

+

Alternative name of vserver

 query @@ -22743,14 +22552,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + prov-status -

Inner VLAN tag

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query - integer + string @@ -22758,14 +22567,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + in-maint -

Neutron network id of the interface that address belongs to

 query - string + boolean @@ -22773,14 +22581,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + is-closed-loop-disabled -

Neutron id of subnet that address belongs to

 query - string + boolean @@ -22812,7 +22619,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /vserver
@@ -22840,17 +22647,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/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 vserver
+

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

Tags: CloudInfrastructure
-

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

+

create or update an existing vserver

@@ -22859,13 +22666,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

+

vserver object that needs to be created or updated

- /l3-interface-ipv6-address-list + /vserver
@@ -22946,38 +22753,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 - - - -
@@ -23009,17 +22784,17 @@ 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}

+
delete an existing vserver
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing vserver

@@ -23103,38 +22878,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 - - - - - - resource-version @@ -23182,36 +22925,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/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

+
returns l-interfaces
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns l-interfaces

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -23290,34 +23016,135 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -23329,6 +23156,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -23351,24 +23201,19 @@ 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

+
returns l-interface
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns l-interface

-
- -

application/json application/xml -

-
- interface-name + cloud-type -

Name given to the interface

+

Type of the cloud (e.g., openstack)

pathquery string -
- l3-interface-ipv6-address + owner-defined-type -

IP address

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

pathquery + 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 + +
@@ -23463,18 +23308,180 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -23486,6 +23493,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interface +
+
+
+ +
default @@ -23508,17 +23538,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/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

+
create or update an existing l-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing l-interface

@@ -23527,13 +23557,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
@@ -23661,17 +23691,17 @@ 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}/relationship-list/relationship

+
delete an existing l-interface
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing l-interface

@@ -23771,6 +23801,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- l3-interface-ipv6-address + cloud-type -

IP address

+

Type of the cloud (e.g., openstack)

pathquery + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ tenant-name + +

Readable name of tenant

+ 		query + string + + +
+ tenant-context + +

This field will store the tenant context.

+ 		query + string + + +
+ vserver-name + +

Name of vserver

+ 		query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query string -
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -23802,17 +23848,17 @@ 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

+
returns l3-interface-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

returns sriov-vfs

+

returns l3-interface-ipv4-address-list

@@ -23907,6 +23953,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + l3-interface-ipv4-address + + +

IP address

+ + path + + string + + + + + + cloud-type @@ -24085,6 +24147,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 + + + + +
@@ -24111,7 +24218,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l3-interface-ipv4-address-list
@@ -24139,19 +24246,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns sriov-vf
-

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

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

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

Tags: CloudInfrastructure
-

returns sriov-vf

+

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

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -24246,10 +24370,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -24260,235 +24384,169 @@ 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-ipv4-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -24552,17 +24588,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/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}

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

see node definition for valid relationships

@@ -24571,13 +24607,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

+

relationship object that needs to be created or updated

- /sriov-vf + /relationship
@@ -24676,10 +24712,10 @@ 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 + cloud-owner -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- interface-id + cloud-region-id -

ID of interface

+

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

querypath string +
- macaddr + tenant-id -

MAC address for the interface

+

Unique id relative to the cloud-region.

querypath string +
- network-name + vserver-id -

Name of the network

+

Unique identifier for this vserver relative to its tenant

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name given to the interface

querypath string +
- vf-mac-filter + l3-interface-ipv4-address -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

IP address

querypath 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 @@ -24496,6 +24554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -24721,17 +24757,17 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -24833,10 +24869,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -24847,22 +24883,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -24894,36 +24914,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/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

+
returns l3-interface-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -25018,103 +25021,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 relationship
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

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

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

- 		path - string - - - -
- cloud-region-id + l3-interface-ipv6-address -

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

+

IP address

 path @@ -25127,210 +25037,143 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-id + cloud-type -

Unique id relative to the cloud-region.

+

Type of the cloud (e.g., openstack)

pathquery string -
- vserver-id + owner-defined-type -

Unique identifier for this vserver relative to its tenant

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

pathquery string -
- interface-name + tenant-name -

Name given to the interface

+

Readable name of tenant

pathquery string -
- pci-id + tenant-context -

PCI ID used to identify the sriov-vf

+

This field will store the tenant context.

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vlans
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns vlans

- -
-
- - - - - - - - - - - - + - + - + - + - + + +
- cloud-owner + vserver-name -

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

+

Name of vserver

pathquery string -
- cloud-region-id + vserver-name2 -

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

+

Alternative name of vserver

pathquery string -
- tenant-id + prov-status -

Unique id relative to the cloud-region.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- vserver-id + in-maint -

Unique identifier for this vserver relative to its tenant

pathquery - string + boolean -
- interface-name + is-closed-loop-disabled -

Name given to the interface

pathquery - string + boolean -
- cloud-type + interface-id -

Type of the cloud (e.g., openstack)

+

ID of interface

 query @@ -25342,10 +25185,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + macaddr -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

MAC address for the interface

 query @@ -25357,10 +25200,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-name + network-name -

Readable name of tenant

+

Name of the network

 query @@ -25372,14 +25215,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-context + vlan-id-inner -

This field will store the tenant context.

+

Inner VLAN tag

 query - string + integer @@ -25387,10 +25230,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-name + neutron-network-id -

Name of vserver

+

Neutron network id of the interface that address belongs to

 query @@ -25402,10 +25245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-name2 + neutron-subnet-id -

Alternative name of vserver

+

Neutron id of subnet that address belongs to

 query @@ -25415,92 +25258,196 @@ 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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated

+

+
+
+
+
+ /l3-interface-ipv6-address-list +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + - + - + @@ -25512,29 +25459,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -25557,19 +25481,24 @@ 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}

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

returns vlan

+

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

+
+ +

application/json application/xml +

+
- prov-status + cloud-owner -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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

querypath string +
- in-maint + cloud-region-id +

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

querypath - boolean + string +
- is-closed-loop-disabled + tenant-id +

Unique id relative to the cloud-region.

querypath - boolean + string +
- interface-id + vserver-id -

ID of interface

+

Unique identifier for this vserver relative to its tenant

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name given to the interface

querypath string +
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -25664,10 +25593,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 @@ -25680,10 +25609,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type + resource-version -

Type of the cloud (e.g., openstack)

+

resource-version for concurrency

 query @@ -25691,199 +25620,333 @@ 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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + - + - + - + - + + +
- owner-defined-type + cloud-owner -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

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

querypath string +
- tenant-name + cloud-region-id -

Readable name of tenant

+

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

querypath string +
- tenant-context + tenant-id -

This field will store the tenant context.

+

Unique id relative to the cloud-region.

querypath string +
- vserver-name + vserver-id -

Name of vserver

+

Unique identifier for this vserver relative to its tenant

querypath string +
- vserver-name2 + interface-name -

Alternative name of vserver

+

Name given to the interface

querypath string +
- prov-status + l3-interface-ipv6-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -25940,17 +25980,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/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}

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

create or update an existing vlan

+

see node definition for valid relationships

@@ -25959,13 +25999,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

- /vlan + /relationship
@@ -26062,22 +26102,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + cloud-owner +

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

querypath - boolean + string +
- interface-id + cloud-region-id -

ID of interface

+

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

querypath string +
- macaddr + tenant-id -

MAC address for the interface

+

Unique id relative to the cloud-region.

querypath string +
- network-name + vserver-id -

Name of the network

+

Unique identifier for this vserver relative to its tenant

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name given to the interface

querypath - integer + string +
- vpn-key + l3-interface-ipv6-address -

This indicates the customers VPN ID associated with this vlan

+

IP address

querypath string +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
@@ -26109,17 +26133,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

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

+

delete an existing relationship

@@ -26219,38 +26243,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 - - - - - - - - - resource-version - - -

resource-version for concurrency

- - query - - string - - - - - -
@@ -26282,17 +26274,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns l3-interface-ipv4-address-list
-

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

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

+

returns sriov-vfs

@@ -26387,38 +26379,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 - - -

IP address

- - path - - string - - - - - - cloud-type @@ -26597,81 +26557,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 - - - - -
@@ -26698,7 +26583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /sriov-vfs
@@ -26726,36 +26611,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 /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns sriov-vf
+

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

Tags: CloudInfrastructure
-

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

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
-
@@ -26850,10 +26718,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 @@ -26866,199 +26734,233 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + cloud-type -

IP address

+

Type of the cloud (e.g., openstack)

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

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

- -
-
- -

application/json application/xml -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -27100,17 +27024,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/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

+
create or update an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing sriov-vf

@@ -27119,13 +27043,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
@@ -27224,26 +27148,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner + owner-defined-type -

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

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

pathquery string -
- cloud-region-id + tenant-name -

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

+

Readable name of tenant

pathquery string -
- tenant-id + tenant-context -

Unique id relative to the cloud-region.

+

This field will store the tenant context.

pathquery string -
- vserver-id + vserver-name -

Unique identifier for this vserver relative to its tenant

+

Name of vserver

pathquery string -
- interface-name + vserver-name2 -

Name given to the interface

+

Alternative name of vserver

pathquery string -
- vlan-interface + prov-status -

String that identifies the interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- l3-interface-ipv4-address + in-maint -

IP address

pathquery + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+ 		query string -
- resource-version + macaddr -

resource-version for concurrency

+

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 @@ -27066,7 +26968,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 + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -27285,17 +27193,17 @@ 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

+
delete an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing sriov-vf

@@ -27397,10 +27305,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 @@ -27413,12 +27321,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 @@ -27458,19 +27366,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/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}

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

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -27565,10 +27490,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 @@ -27579,12 +27504,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

IP address

+

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

 path @@ -27597,85 +27583,226 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type + cloud-region-id -

Type of the cloud (e.g., openstack)

+

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

querypath string +
- owner-defined-type + tenant-id -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

Unique id relative to the cloud-region.

querypath string +
- tenant-name + vserver-id -

Readable name of tenant

+

Unique identifier for this vserver relative to its tenant

querypath string +
- tenant-context + interface-name -

This field will store the tenant context.

+

Name given to the interface

querypath string +
- vserver-name + pci-id -

Name of vserver

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlans
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vlans

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vserver-name2 + cloud-owner -

Alternative name of vserver

+

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

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

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

+ 		path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

 query @@ -27687,10 +27814,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + owner-defined-type -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -27702,13 +27829,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + tenant-name +

Readable name of tenant

 query - boolean + string @@ -27716,13 +27844,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- is-closed-loop-disabled + tenant-context +

This field will store the tenant context.

 query - boolean + string @@ -27730,10 +27859,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vserver-name -

ID of interface

+

Name of vserver

 query @@ -27745,10 +27874,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vserver-name2 -

MAC address for the interface

+

Alternative name of vserver

 query @@ -27760,10 +27889,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 @@ -27775,14 +27904,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + in-maint -

Inner VLAN tag

 query - integer + boolean @@ -27790,14 +27918,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + is-closed-loop-disabled -

This indicates the customers VPN ID associated with this vlan

 query - string + boolean @@ -27805,14 +27932,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 @@ -27820,10 +27947,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 @@ -27835,10 +27962,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 @@ -27874,7 +28001,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /vlans
@@ -27902,36 +28029,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+

returns vlan

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
-
@@ -28042,199 +28152,203 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- l3-interface-ipv6-address + cloud-type -

IP address

+

Type of the cloud (e.g., openstack)

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

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

- -
-
- -

application/json application/xml -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -28276,17 +28412,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/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

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

see node definition for valid relationships

+

create or update an existing vlan

@@ -28295,13 +28431,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
@@ -28414,22 +28550,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- cloud-owner + owner-defined-type -

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

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

pathquery string -
- cloud-region-id + tenant-name -

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

+

Readable name of tenant

pathquery string -
- tenant-id + tenant-context -

Unique id relative to the cloud-region.

+

This field will store the tenant context.

pathquery string -
- vserver-id + vserver-name -

Unique identifier for this vserver relative to its tenant

+

Name of vserver

pathquery string -
- interface-name + vserver-name2 -

Name given to the interface

+

Alternative name of vserver

pathquery string -
- vlan-interface + prov-status -

String that identifies the interface

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- l3-interface-ipv6-address + in-maint -

IP address

pathquery + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+ 		query string -
- resource-version + macaddr -

resource-version for concurrency

+

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 @@ -28242,7 +28356,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- l3-interface-ipv6-address - -

IP address

- 		path - string - - - -
@@ -28461,17 +28581,17 @@ 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

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

+

delete an existing vlan

@@ -28589,12 +28709,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 @@ -28634,36 +28754,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/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

+
returns l3-interface-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

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 -
-
-
-
@@ -28772,6 +28875,275 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
+ cloud-type + +

Type of the cloud (e.g., openstack)

+ 		query + string + + +
+ owner-defined-type + +

Cloud-owner defined type indicator (e.g., dcp, lcp)

+ 		query + string + + +
+ tenant-name + +

Readable name of tenant

+ 		query + string + + +
+ tenant-context + +

This field will store the tenant context.

+ 		query + string + + +
+ vserver-name + +

Name of vserver

+ 		query + string + + +
+ vserver-name2 + +

Alternative name of vserver

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
@@ -28781,6 +29153,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 @@ -28803,23 +29198,35 @@ 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}/relationship-list/relationship

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

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

Tags: CloudInfrastructure
-

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
@@ -28929,6 +29336,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
@@ -28960,35 +29383,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}/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 -
-
-
@@ -29066,73 +29477,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}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- cloud-owner + interface-name -

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

+

Name given to the interface

 path @@ -29145,10 +29495,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + vlan-interface -

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

+

String that identifies the interface

 path @@ -29161,10 +29511,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-id + l3-interface-ipv4-address -

Unique id relative to the cloud-region.

+

IP address

 path @@ -29177,12 +29527,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-id + resource-version -

Unique identifier for this vserver relative to its tenant

+

resource-version for concurrency

pathquery string @@ -29222,19 +29572,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volumes
-

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

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

returns volumes

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -29313,135 +29680,223 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + +
- cloud-type + interface-name -

Type of the cloud (e.g., openstack)

+

Name given to the interface

querypath string +
- owner-defined-type + vlan-interface -

Cloud-owner defined type indicator (e.g., dcp, lcp)

+

String that identifies the interface

querypath string +
- tenant-name + l3-interface-ipv4-address -

Readable name of tenant

+

IP address

querypath + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volumes -
-
-
- -
default @@ -29498,17 +29930,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns volume
-

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

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

+

returns l3-interface-ipv6-address-list

@@ -29589,10 +30021,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ cloud-owner + +

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

+ 		path string +
- tenant-context + cloud-region-id -

This field will store the tenant context.

+

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

querypath string +
- vserver-name + tenant-id -

Name of vserver

+

Unique id relative to the cloud-region.

querypath string +
- vserver-name2 + vserver-id -

Alternative name of vserver

+

Unique identifier for this vserver relative to its tenant

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Name given to the interface

querypath string +
- in-maint + vlan-interface +

String that identifies the interface

querypath - boolean + string +
- is-closed-loop-disabled + l3-interface-ipv4-address +

IP address

querypath - boolean + string +
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -29736,6 +30200,126 @@ 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 + + +
+ 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 + + +
@@ -29762,7 +30346,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /volume + /l3-interface-ipv6-address-list
@@ -29790,17 +30374,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing volume
-

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

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

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

Tags: CloudInfrastructure
-

create or update an existing volume

+

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

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

-

volume object that needs to be created or updated

+

l3-interface-ipv6-address-list object that needs to be created or updated

- /volume + /l3-interface-ipv6-address-list
@@ -29898,10 +30482,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -29943,17 +30559,17 @@ 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}

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

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

Tags: CloudInfrastructure
-

delete an existing volume

+

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

@@ -30039,10 +30655,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -30100,11 +30748,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

+

PUT /cloud-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
@@ -30208,10 +30856,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -30253,11 +30933,11 @@ 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

+

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
@@ -30349,10 +31029,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + interface-name -

Unique ID of block storage volume relative to the vserver.

+

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

 path @@ -30394,19 +31106,36 @@ 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

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

returns volume-groups

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -30453,66 +31182,77 @@ 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 +
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volume-groups -
-
-
+
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+
-
+
+

application/json application/xml +

+ +
default @@ -30535,19 +31275,24 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

returns volume-group

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -30594,10 +31339,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + - + - + @@ -30692,29 +31410,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volume-group -
-
-
- -
default @@ -30737,17 +31432,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}

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

create or update an existing volume-group

+

see node definition for valid relationships

@@ -30756,13 +31451,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

+

relationship object that needs to be created or updated

- /volume-group + /relationship
@@ -30813,10 +31508,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

Unique id relative to the cloud-region.

 path @@ -30610,77 +31355,50 @@ 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 + vserver-id -

Name of the volume group.

+

Unique identifier for this vserver relative to its tenant

querypath string +
- heat-stack-id + interface-name -

Heat stack id corresponding to this volume-group

+

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 +
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

 path @@ -30858,17 +31569,17 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

delete an existing volume-group

+

delete an existing relationship

@@ -30922,10 +31633,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

Unique id relative to the cloud-region.

 path @@ -30938,12 +31649,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vserver-id -

resource-version for concurrency

+

Unique identifier for this vserver relative to its tenant

querypath string @@ -30983,36 +31694,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+
returns volumes
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns volumes

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -31059,10 +31753,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- volume-group-id + tenant-id -

Unique ID of volume-group.

+

Unique id relative to the cloud-region.

 path @@ -31073,73 +31767,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}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - + - -
- cloud-owner + vserver-id -

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

+

Unique identifier for this vserver relative to its tenant

 path @@ -31152,178 +31785,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + cloud-type -

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

+

Type of the cloud (e.g., openstack)

pathquery string -
- volume-group-id + owner-defined-type -

Unique ID of volume-group.

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns complexes
-

GET /cloud-infrastructure/complexes

- Tags: - CloudInfrastructure -
-
-
-

returns complexes

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /complexes -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns complex
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns complex

- -
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + tenant-name -

Unique identifier for physical location, e.g., CLLI

+

Readable name of tenant

pathquery string -
- data-center-code + tenant-context -

Data center code which can be an alternate way to identify a complex

+

This field will store the tenant context.

 query @@ -31335,10 +31845,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- complex-name + vserver-name -

Gamma complex name for LCP instance.

+

Name of vserver

 query @@ -31350,10 +31860,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- identity-url + vserver-name2 -

URL of the keystone identity service

+

Alternative name of vserver

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -31363,6 +31888,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
@@ -31389,7 +31942,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /complex + /volumes
@@ -31417,36 +31970,19 @@ 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}

+
returns volume
+

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

Tags: CloudInfrastructure
-

create or update an existing complex

+

returns volume

-
- -

application/json application/xml -

-
-
-

complex object that needs to be created or updated

-

-
-
-
-
- /complex -
-
-
-
@@ -31461,10 +31997,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 @@ -31475,73 +32011,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 @@ -31554,12 +32029,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + tenant-id -

resource-version for concurrency

+

Unique id relative to the cloud-region.

querypath string @@ -31568,68 +32043,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 ctag-pools
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns ctag-pools

- -
-
- - - - - - - - - - - - + - -
- physical-location-id + vserver-id -

Unique identifier for physical location, e.g., CLLI

+

Unique identifier for this vserver relative to its tenant

 path @@ -31642,25 +32061,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code + volume-id -

Data center code which can be an alternate way to identify a complex

+

Unique ID of block storage volume relative to the vserver.

querypath string +
- complex-name + cloud-type -

Gamma complex name for LCP instance.

+

Type of the cloud (e.g., openstack)

 query @@ -31672,10 +32092,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- identity-url + owner-defined-type -

URL of the keystone identity service

+

Cloud-owner defined type indicator (e.g., dcp, lcp)

 query @@ -31685,139 +32105,57 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /ctag-pools -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns ctag-pool
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns ctag-pool

- -
-
- - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- physical-location-id + tenant-name -

Unique identifier for physical location, e.g., CLLI

+

Readable name of tenant

pathquery string -
- target-pe + tenant-context -

The Target provider edge router

+

This field will store the tenant context.

pathquery string -
- availability-zone-name + vserver-name -

Name of the availability zone

+

Name of vserver

pathquery string -
- data-center-code + vserver-name2 -

Data center code which can be an alternate way to identify a complex

+

Alternative name of vserver

 query @@ -31829,10 +32167,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- complex-name + prov-status -

Gamma complex name for LCP instance.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query @@ -31844,14 +32182,27 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- identity-url + in-maint -

URL of the keystone identity service

 query - string + boolean + + +
+ is-closed-loop-disabled + + query + boolean @@ -31883,7 +32234,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ctag-pool + /volume
@@ -31911,17 +32262,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}

+
create or update an existing volume
+

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

Tags: CloudInfrastructure
-

create or update an existing ctag-pool

+

create or update an existing volume

@@ -31930,13 +32281,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

+

volume object that needs to be created or updated

- /ctag-pool + /volume
@@ -31955,10 +32306,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 @@ -31971,10 +32322,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 @@ -31987,10 +32338,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

 path @@ -32032,17 +32415,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 volume
+

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

Tags: CloudInfrastructure
-

delete an existing ctag-pool

+

delete an existing volume

@@ -32064,10 +32447,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 @@ -32080,10 +32463,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 @@ -32096,10 +32479,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

 path @@ -32157,11 +32572,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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -32201,10 +32616,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 @@ -32217,10 +32632,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 @@ -32233,10 +32648,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

 path @@ -32278,11 +32725,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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -32310,10 +32757,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 @@ -32326,10 +32773,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 @@ -32342,10 +32789,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- availability-zone-name + tenant-id -

Name of the availability zone

+

Unique id relative to the cloud-region.

+ 		path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+ 		path + string + + + +
+ volume-id + +

Unique ID of block storage volume relative to the vserver.

 path @@ -32387,36 +32866,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 -
-
-
-
@@ -32431,10 +32893,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 @@ -32445,73 +32907,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/complexes/complex/{physical-location-id}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

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 @@ -32522,51 +32923,40 @@ 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 + + +
-
-

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

@@ -32589,7 +32979,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-profiles + /volume-groups
@@ -32617,17 +33007,17 @@ 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}

+
returns volume-group
+

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

Tags: CloudInfrastructure
-

returns network-profile

+

returns volume-group

@@ -32644,10 +33034,26 @@ 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 @@ -32658,6 +33064,97 @@ 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 + + + +
+ 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 + + +
@@ -32684,7 +33181,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /network-profile + /volume-group
@@ -32712,17 +33209,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}

+
create or update an existing volume-group
+

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

Tags: CloudInfrastructure
-

create or update an existing network-profile

+

create or update an existing volume-group

@@ -32731,13 +33228,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
@@ -32756,10 +33253,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 @@ -32801,17 +33330,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

@@ -32833,10 +33362,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 @@ -32894,11 +33455,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
@@ -32938,10 +33499,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 @@ -32983,11 +33576,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
@@ -33015,10 +33608,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 @@ -33060,17 +33685,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

@@ -33096,7 +33721,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pservers + /complexes
@@ -33124,17 +33749,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

@@ -33151,10 +33776,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 @@ -33167,10 +33792,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 @@ -33182,10 +33807,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 @@ -33197,24 +33822,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 @@ -33250,7 +33861,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pserver + /complex
@@ -33278,17 +33889,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

@@ -33297,13 +33908,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

- /pserver + /complex
@@ -33322,10 +33933,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 @@ -33367,17 +33978,17 @@ 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}

+
delete an existing complex
+

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

Tags: CloudInfrastructure
-

delete an existing pserver

+

delete an existing complex

@@ -33399,10 +34010,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 @@ -33460,17 +34071,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

@@ -33487,10 +34098,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 @@ -33503,10 +34114,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 @@ -33518,10 +34129,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 @@ -33533,24 +34144,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 @@ -33586,7 +34183,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /ctag-pools
@@ -33614,17 +34211,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

@@ -33641,10 +34238,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 @@ -33657,10 +34254,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 @@ -33673,54 +34270,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 @@ -33732,10 +34301,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 @@ -33747,10 +34316,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 @@ -33786,7 +34355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interface + /ctag-pool
@@ -33814,17 +34383,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

@@ -33833,13 +34402,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

- /lag-interface + /ctag-pool
@@ -33858,10 +34427,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 @@ -33874,10 +34443,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 @@ -33919,17 +34504,17 @@ 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}

+
delete an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

delete an existing lag-interface

+

delete an existing ctag-pool

@@ -33951,10 +34536,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 @@ -33967,10 +34552,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 @@ -34028,19 +34629,36 @@ 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

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

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -34055,10 +34673,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -34183,29 +34728,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -34228,19 +34750,24 @@ 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}

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

returns l-interface

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- hostname + physical-location-id -

Value from executing hostname on the compute node.

+

Unique identifier for physical location, e.g., CLLI

 path @@ -34071,10 +34689,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 @@ -34087,91 +34705,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 - - -
- interface-id - -

ID of interface

- 		query - string - - -
- interface-role + availability-zone-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Name of the availability zone

querypath string +
@@ -34255,10 +34782,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 @@ -34271,10 +34798,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 @@ -34287,10 +34814,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 @@ -34301,140 +34828,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 - - -
@@ -34444,29 +34837,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -34489,17 +34859,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

@@ -34508,13 +34878,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

- /l-interface + /relationship
@@ -34533,42 +34903,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 @@ -34610,17 +34948,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

@@ -34642,42 +34980,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 @@ -34688,22 +34994,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -34735,17 +35025,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

@@ -34762,58 +35116,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 @@ -34824,185 +35130,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 - - -
@@ -35029,7 +35156,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /network-profile
@@ -35057,17 +35184,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

@@ -35076,13 +35203,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

- /l3-interface-ipv4-address-list + /network-profile
@@ -35101,58 +35228,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 @@ -35194,17 +35273,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 /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing network-profile
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing network-profile

@@ -35226,58 +35305,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 @@ -35335,11 +35366,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
@@ -35379,58 +35410,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 @@ -35472,11 +35455,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
@@ -35504,58 +35487,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 @@ -35597,17 +35532,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

@@ -35638,54 +35637,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 @@ -35745,126 +35696,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 - - -
@@ -35891,7 +35722,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /pserver
@@ -35919,17 +35750,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

@@ -35938,13 +35769,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

- /l3-interface-ipv6-address-list + /pserver
@@ -35977,54 +35808,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 - - - - - -
@@ -36056,17 +35839,17 @@ 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}

+
delete an existing pserver
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing pserver

@@ -36102,54 +35885,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 - - - - - - resource-version @@ -36197,36 +35932,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-interfaces
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns lag-interfaces

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -36257,50 +35975,61 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -36312,6 +36041,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interfaces +
+
+
+ +
default @@ -36334,24 +36086,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}/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
-

delete an existing relationship

+

returns lag-interface

-
- -

application/json application/xml -

-
- 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 + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query string -
@@ -36398,34 +36145,91 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -36437,6 +36241,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /lag-interface +
+
+
+ +
default @@ -36459,17 +36286,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

+
create or update an existing lag-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing lag-interface

@@ -36478,13 +36305,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
@@ -36533,22 +36360,6 @@ 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 + 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 -
- interface-name - -

Name given to the interface

- 		path - string - - - -
@@ -36580,17 +36391,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

@@ -36644,12 +36455,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

- path + query string @@ -36689,17 +36500,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

@@ -36746,22 +36557,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 @@ -36851,51 +36646,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 - - - - -
@@ -36922,7 +36672,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l-interfaces
@@ -36950,17 +36700,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

@@ -37023,22 +36773,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 @@ -37173,64 +36907,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + +
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + - + - + - - - - - - - - + @@ -37242,29 +37060,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -37287,35 +37082,23 @@ 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}

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

create or update an existing sriov-vf

+

delete an existing l-interface

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated

-

-
-
-
-
- /sriov-vf -
-
-
- vf-vlan-filter + hostname -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Value from executing hostname on the compute node.

querypath string +
- vf-mac-filter + interface-name -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Name that identifies the link aggregate interface

querypath 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 + interface-name -

Neutron network id of the interface

+

Name given to the interface

querypath string +
@@ -37379,12 +37162,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 @@ -37424,24 +37207,19 @@ 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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

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

delete an existing sriov-vf

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -37504,10 +37282,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -37543,6 +37484,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 @@ -37565,17 +37529,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

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

see node definition for valid relationships

+

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

@@ -37584,13 +37548,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
@@ -37657,10 +37621,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + +
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -37520,10 +37298,174 @@ 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 + + +
+ 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 @@ -37531,7 +37473,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -37702,17 +37666,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 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 relationship

+

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

@@ -37782,10 +37746,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -37796,6 +37760,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -37827,19 +37807,36 @@ 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

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

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -37902,136 +37899,143 @@ 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 + 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 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 +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -38088,17 +38069,17 @@ 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}

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

+

returns l3-interface-ipv6-address-list

@@ -38163,10 +38144,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- interface-role + hostname -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

Value from executing hostname on the compute node.

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

String that identifies the interface

+

IP address

 path @@ -38328,10 +38309,25 @@ 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 + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -38367,7 +38363,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l3-interface-ipv6-address-list
@@ -38395,17 +38391,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}

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

+

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

@@ -38414,13 +38410,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-ipv6-address-list object that needs to be created or updated

- /vlan + /l3-interface-ipv6-address-list
@@ -38487,10 +38483,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 @@ -38532,17 +38528,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-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing vlan

+

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

@@ -38612,10 +38608,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 @@ -38673,19 +38669,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-ipv6-address-list/{l3-interface-ipv6-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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -38748,23 +38761,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

@@ -38778,215 +38775,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 - - -
- 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 - - -
@@ -38996,29 +38784,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 @@ -39041,35 +38806,23 @@ 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}

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

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

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv4-address-list -
-
-
@@ -39133,23 +38886,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

@@ -39194,23 +38931,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}

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

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

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
@@ -39272,54 +39021,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 - -

IP address

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

resource-version for concurrency

- 		query - string - - - -
@@ -39351,35 +39052,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 relationship
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
@@ -39441,38 +39130,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 - -

IP address

- 		path - string - - - -
@@ -39504,24 +39161,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}/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 sriov-vfs
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -39584,34 +39236,136 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -39623,6 +39377,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
default @@ -39645,17 +39422,17 @@ 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}

+
returns sriov-vf
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

returns sriov-vf

@@ -39720,26 +39497,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + inv-status -

String that identifies the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- l3-interface-ipv4-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 + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query string -
- 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 @@ -39886,14 +39647,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 @@ -39901,10 +39662,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + vf-mac-filter -

This indicates the customers VPN ID associated with this vlan

+

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

 query @@ -39916,14 +39677,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + vf-vlan-strip -

Inner VLAN tag

+

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

 query - integer + boolean @@ -39934,22 +39695,7 @@ 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 - -

Neutron id of subnet that address belongs to

+

Neutron network id of the interface

 query @@ -39985,7 +39731,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /sriov-vf
@@ -40013,17 +39759,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

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

+

create or update an existing sriov-vf

@@ -40032,13 +39778,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

- /l3-interface-ipv6-address-list + /sriov-vf
@@ -40105,26 +39851,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 @@ -40166,17 +39896,17 @@ 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

+

delete an existing sriov-vf

@@ -40246,26 +39976,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 @@ -40323,11 +40037,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}/vlans/vlan/{vlan-interface}/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -40415,26 +40129,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 @@ -40476,11 +40174,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}/vlans/vlan/{vlan-interface}/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -40556,26 +40254,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 @@ -40617,36 +40299,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}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+
returns vlans
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns vlans

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -40709,18 +40374,136 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -40732,6 +40515,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
default @@ -40754,24 +40560,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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

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

delete an existing relationship

+

returns vlan

-
- -

application/json application/xml -

-
- vlan-interface + inv-status -

String that identifies the interface

+

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 + + +
+ 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 -
@@ -40848,6 +40649,170 @@ 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 + + +
@@ -40857,6 +40822,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -40879,17 +40867,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}/relationship-list/relationship

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

see node definition for valid relationships

+

create or update an existing vlan

@@ -40898,13 +40886,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
@@ -40953,73 +40941,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/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - + + + + + + + +
- hostname + interface-name -

Value from executing hostname on the compute node.

+

Name given to the interface

 path @@ -41032,10 +40959,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name that identifies the link aggregate interface

+

String that identifies the interface

 path @@ -41077,19 +41004,24 @@ 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

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

returns p-interfaces

+

delete an existing vlan

+
+ +

application/json application/xml +

+
@@ -41120,54 +41052,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + @@ -41186,29 +41123,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interfaces -
-
-
- -
default @@ -41231,17 +41145,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interface
-

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

+
returns l3-interface-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

returns p-interface

+

returns l3-interface-ipv4-address-list

@@ -41277,7 +41191,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
- + - + - + - -
- 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 + vlan-interface +

String that identifies the interface

querypath - boolean + string +
- pserver-name2 + resource-version -

alternative pserver name

+

resource-version for concurrency

 query @@ -41175,6 +41111,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -41290,54 +41204,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 given to the interface

querypath string +
- pserver-id + vlan-interface -

ID of Pserver

+

String that identifies the interface

querypath string +
- in-maint + l3-interface-ipv4-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 @@ -41349,10 +41267,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 @@ -41362,233 +41280,71 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interface -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing p-interface
-

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

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing p-interface

- -
-
- -

application/json application/xml -

-
-
-

p-interface object that needs to be created or updated

-

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

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

Value from executing hostname on the compute node.

+

ID of interface

pathquery string -
- interface-name + interface-role -

Name that identifies the physical interface

+

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 @@ -41596,107 +41352,48 @@ 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 + macaddr -

Value from executing hostname on the compute node.

+

MAC address for the interface

pathquery string -
- interface-name + network-name -

Name that identifies the physical interface

+

Name of the network

pathquery string -
- inv-status + vlan-id-inner -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Inner VLAN tag

 query - string + integer @@ -41704,10 +41401,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + vpn-key -

ID of Pserver

+

This indicates the customers VPN ID associated with this vlan

 query @@ -41719,13 +41416,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint + vlan-id-inner +

Inner VLAN tag

 query - boolean + integer @@ -41733,10 +41431,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + neutron-network-id -

alternative pserver name

+

Neutron network id of the interface that address belongs to

 query @@ -41748,10 +41446,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + neutron-subnet-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Neutron id of subnet that address belongs to

 query @@ -41787,7 +41485,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interfaces + /l3-interface-ipv4-address-list
@@ -41815,19 +41513,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 l3-interface-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -41861,7 +41576,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 @@ -41890,114 +41605,183 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + vlan-interface -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

String that identifies the interface

querypath string +
- pserver-id + l3-interface-ipv4-address -

ID of Pserver

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -42061,17 +41823,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}

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

see node definition for valid relationships

@@ -42080,13 +41842,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

- /l-interface + /relationship
@@ -42124,7 +41886,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + + + + + + + + +
- in-maint + hostname +

Value from executing hostname on the compute node.

querypath - boolean + string +
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the link aggregate interface

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

 path @@ -42151,6 +41913,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-ipv4-address + +

IP address

+ 		path + string + + + +
@@ -42182,17 +41976,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 relationship
+

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

Tags: CloudInfrastructure
-

delete an existing l-interface

+

delete an existing relationship

@@ -42233,7 +42027,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 @@ -42262,12 +42056,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 @@ -42307,17 +42117,17 @@ 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}

+
returns l3-interface-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

returns l3-interface-ipv6-address-list

@@ -42353,7 +42163,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 @@ -42382,7 +42192,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

@@ -42457,10 +42283,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 @@ -42530,6 +42371,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 @@ -42586,7 +42457,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
@@ -42614,17 +42485,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}/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-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

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

+

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

@@ -42633,13 +42504,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
@@ -42677,7 +42548,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 @@ -42706,10 +42577,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 @@ -42720,16 +42591,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
+
+ l3-interface-ipv6-address + +

IP address

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

application/json application/xml +

+ +
+
default
@@ -42751,17 +42638,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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing l3-interface-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-ipv4-address-list

+

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

@@ -42802,7 +42689,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 @@ -42831,7 +42718,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

@@ -42892,11 +42795,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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -42955,7 +42858,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 @@ -42984,7 +42887,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

@@ -43029,11 +42948,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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -43080,7 +42999,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 @@ -43109,7 +43028,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

@@ -43154,19 +43089,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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}/vlans/vlan/{vlan-interface}/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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -43200,7 +43152,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 @@ -43229,10 +43181,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 @@ -43243,170 +43195,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 - - -
- 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 - - -
@@ -43416,29 +43204,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 @@ -43461,35 +43226,23 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated

-

-
-
-
-
- /l3-interface-ipv6-address-list -
-
-
@@ -43524,7 +43277,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 @@ -43553,10 +43306,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 @@ -43598,23 +43351,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}/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}/relationship-list/relationship

Tags: CloudInfrastructure
-

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

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
@@ -43649,7 +43414,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 @@ -43660,12 +43425,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}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - -
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

 path @@ -43678,10 +43504,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 @@ -43692,22 +43518,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -43739,36 +43549,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns p-interfaces
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns p-interfaces

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -43799,50 +43592,61 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + + + + + + + + @@ -43854,6 +43658,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interfaces +
+
+
+ +
default @@ -43876,24 +43703,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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns p-interface
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns p-interface

-
- -

application/json application/xml -

-
- 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 -
- interface-name + pserver-id -

Name given to the interface

+

ID of Pserver

pathquery string -
- l3-interface-ipv6-address + in-maint -

IP address

pathquery + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query string -
@@ -43940,34 +43762,76 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + + + + + + + + + + + + + + + + + + + + + @@ -43979,6 +43843,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
default @@ -44001,17 +43888,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
create or update an existing p-interface
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

create or update an existing p-interface

@@ -44020,13 +43907,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
@@ -44075,22 +43962,6 @@ 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 + pserver-id -

IP address

+

ID of Pserver

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

Name given to the interface

- 		path - string - - - -
@@ -44122,17 +43993,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
delete an existing p-interface
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing p-interface

@@ -44186,12 +44057,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 @@ -44231,17 +44102,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+
returns l-interfaces
+

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

Tags: CloudInfrastructure
-

returns sriov-vfs

+

returns l-interfaces

@@ -44288,22 +44159,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 @@ -44378,51 +44233,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 - - -
@@ -44449,7 +44259,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l-interfaces
@@ -44477,17 +44287,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
returns l-interface
+

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

Tags: CloudInfrastructure
-

returns sriov-vf

+

returns l-interface

@@ -44550,22 +44360,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 @@ -44685,64 +44479,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated

+

+
+
+
+
+ /l-interface +
+
+
+
+
+ + + + + + + + + + + - + - + - - - - - - - - + @@ -44754,29 +44632,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -44799,35 +44654,23 @@ 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}

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

create or update an existing sriov-vf

+

delete an existing l-interface

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated

-

-
-
-
-
- /sriov-vf -
-
-
- vf-vlan-filter + hostname -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Value from executing hostname on the compute node.

querypath string +
- vf-mac-filter + interface-name -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Name that identifies the physical interface

querypath 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 + interface-name -

Neutron network id of the interface

+

Name given to the interface

querypath string +
@@ -44891,12 +44734,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 @@ -44936,24 +44779,19 @@ 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}

+
returns l3-interface-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -45016,10 +44854,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -45055,6 +45041,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 @@ -45077,17 +45086,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}/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 /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

+

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

@@ -45096,13 +45105,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
@@ -45169,10 +45178,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + +
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -45032,10 +44870,159 @@ 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 + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -45043,7 +45030,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -45214,17 +45223,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}/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-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

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

@@ -45294,10 +45303,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

 path @@ -45308,6 +45317,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -45339,19 +45364,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns vlans
-

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

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

returns vlans

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -45414,121 +45456,143 @@ 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 + l3-interface-ipv4-address -

alternative pserver name

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -45585,17 +45626,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 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 vlan

+

returns l3-interface-ipv6-address-list

@@ -45660,10 +45701,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + +
- 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 + 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-interface + l3-interface-ipv6-address -

String that identifies the interface

+

IP address

 path @@ -45810,10 +45851,25 @@ 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 + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -45849,7 +45905,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /l3-interface-ipv6-address-list
@@ -45877,17 +45933,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 l3-interface-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

create or update an existing vlan

+

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

@@ -45896,13 +45952,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-ipv6-address-list object that needs to be created or updated

- /vlan + /l3-interface-ipv6-address-list
@@ -45969,10 +46025,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 @@ -46014,17 +46070,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

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

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

Tags: CloudInfrastructure
-

delete an existing vlan

+

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

@@ -46094,10 +46150,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 @@ -46155,19 +46211,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}/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 /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
-

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -46230,10 +46303,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 @@ -46244,12 +46317,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - + - + @@ -46463,29 +46451,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 @@ -46508,17 +46473,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}/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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

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

+

see node definition for valid relationships

@@ -46527,13 +46492,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

- /l3-interface-ipv4-address-list + /relationship
@@ -46598,38 +46563,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - -
- l3-interface-ipv4-address + hostname -

IP address

+

Value from executing hostname on the compute node.

 path @@ -46262,196 +46396,50 @@ 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 + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name that identifies the physical interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- vlan-interface - -

String that identifies the interface

- 		path - string - - - -
- l3-interface-ipv4-address - -

IP address

- 		path - string - - - -
@@ -46661,17 +46594,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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing relationship

@@ -46739,12 +46672,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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- vlan-interface + hostname -

String that identifies the interface

+

Value from executing hostname on the compute node.

 path @@ -46757,10 +46746,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 @@ -46773,20 +46762,461 @@ 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

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

 query string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

+ 		path + string
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vf-vlan-filter + +

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+ 		query + string + + +
+ vf-mac-filter + +

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+ 		query + string + + +
+ vf-vlan-strip + +

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+ 		query + boolean + + +
+ neutron-network-id + +

Neutron network id of the interface

+ 		query + string + + +
@@ -46796,6 +47226,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -46818,17 +47271,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}/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

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

see node definition for valid relationships

+

create or update an existing sriov-vf

@@ -46837,13 +47290,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
@@ -46910,26 +47363,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-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -46971,17 +47408,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}/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 sriov-vf
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing sriov-vf

@@ -47051,10 +47488,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 @@ -47067,10 +47504,147 @@ 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

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ pci-id + +

PCI ID used to identify the sriov-vf

 path @@ -47112,19 +47686,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -47187,10 +47766,82 @@ 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 + 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 @@ -47203,10 +47854,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 + + + +
+ interface-name + +

Name given to the interface

 path @@ -47336,16 +48003,174 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
- vlan-id-inner + pserver-id -

Inner VLAN tag

+

ID of Pserver

 query - integer + string @@ -47353,10 +48178,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpn-key + in-maint -

This indicates the customers VPN ID associated with this vlan

+ 		query + boolean + + +
+ pserver-name2 + +

alternative pserver name

 query @@ -47368,14 +48207,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + prov-status -

Inner VLAN tag

+

Trigger for operational monitoring of this resource by Service Assurance systems.

 query - integer + string @@ -47383,10 +48222,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 @@ -47398,17 +48237,5578 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated

+

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

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated

+

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

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv6-address + +

IP address

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pfs
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pfs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pf

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ pserver-id + +

ID of Pserver

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ pserver-name2 + +

alternative pserver name

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-pf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-pf
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-pf object that needs to be created or updated

+

+
+
+
+
+ /sriov-pf +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing sriov-pf
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing sriov-pf

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ pf-pci-id + +

Identifier for the sriov-pf

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns virtual-data-centers
+

GET /cloud-infrastructure/virtual-data-centers

+ Tags: + CloudInfrastructure +
+
+
+

returns virtual-data-centers

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /virtual-data-centers +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns virtual-data-center
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns virtual-data-center

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

+ 		path + string + + + +
+ vdc-name + +

Name of the virtual data center

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /virtual-data-center +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing virtual-data-center
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+

virtual-data-center object that needs to be created or updated

+

+
+
+
+
+ /virtual-data-center +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing virtual-data-center
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing virtual-data-center

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vdc-id + +

Unique ID of the vdc

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

Unique ID of EMS.

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

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

Unique ID of EMS.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing esr-ems
+

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

+ Tags: + ExternalSystem +
+
+
+

delete an existing esr-ems

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

resource-version for concurrency

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

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

Unique ID of EMS.

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-system-info-list +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

+ Tags: + ExternalSystem +
+
+
+

returns esr-system-info

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

Unique ID of esr system info.

+ 		path + string + + + +
+ system-name + +

name of external system.

+ 		query + string + + +
+ system-type + +

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-system-info +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

+ Tags: + ExternalSystem +
+
+
+

create or update an existing esr-system-info

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /esr-system-info +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

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

Unique ID of EMS.

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

Unique ID of esr system info.

+ 		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 /external-system/esr-ems-list/esr-ems/{ems-id}/esr-system-info-list/esr-system-info/{esr-system-info-id}/relationship-list/relationship

+ Tags: + ExternalSystem +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

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

+ Tags: + ExternalSystem +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

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

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

+ Tags: + ExternalSystem +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + ExternalSystem +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ ems-id + +

Unique ID of EMS.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

+ Tags: + ExternalSystem +
+
+
+

returns esr-thirdparty-sdnc

+ +
+
+ + + + + + + + + + + + + - + @@ -47437,7 +53837,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /esr-thirdparty-sdnc
@@ -47465,17 +53865,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}/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 esr-thirdparty-sdnc
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

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

+

create or update an existing esr-thirdparty-sdnc

@@ -47484,13 +53884,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

+

esr-thirdparty-sdnc object that needs to be created or updated

- /l3-interface-ipv6-address-list + /esr-thirdparty-sdnc
@@ -47509,74 +53909,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -73541,7 +80184,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vig-server + /l3-network
@@ -73569,17 +80212,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 l3-network
+

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

Tags: Network
-

create or update an existing vig-server

+

create or update an existing l3-network

@@ -73588,13 +80231,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

+

l3-network object that needs to be created or updated

- /vig-server + /l3-network
@@ -73613,10 +80256,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ +
+ thirdparty-sdnc-id -

Neutron id of subnet that address belongs to

+

Unique ID of SDNC.

querypath string +
- 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 + thirdparty-sdnc-id -

IP address

+

Unique ID of SDNC.

 path @@ -47618,17 +53954,17 @@ 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}

+
delete an existing esr-thirdparty-sdnc
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

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

+

delete an existing esr-thirdparty-sdnc

@@ -47650,74 +53986,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 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 + thirdparty-sdnc-id -

IP address

+

Unique ID of SDNC.

 path @@ -47775,36 +54047,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}/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

+
returns esr-system-info-list
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

see node definition for valid relationships

+

returns esr-system-info-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -47819,74 +54074,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 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 + thirdparty-sdnc-id -

IP address

+

Unique ID of SDNC.

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-system-info-list +
+
+
+ +
default @@ -47928,24 +54142,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

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

Tags: - CloudInfrastructure + ExternalSystem
-

delete an existing relationship

+

returns esr-system-info

-
- -

application/json application/xml -

-
@@ -47960,26 +54169,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -48047,6 +54238,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-system-info +
+
+
+ +
default @@ -48069,17 +54283,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

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

Tags: - CloudInfrastructure + ExternalSystem
-

see node definition for valid relationships

+

create or update an existing esr-system-info

@@ -48088,13 +54302,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

+

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

- /relationship + /esr-system-info
@@ -48113,42 +54327,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 + thirdparty-sdnc-id -

Name that identifies the physical interface

+

Unique ID of SDNC.

 path @@ -47992,10 +54185,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + esr-system-info-id -

Name given to the interface

+

Unique ID of esr system info.

 path @@ -48008,34 +54201,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + system-name -

String that identifies the interface

+

name of external system.

pathquery string -
- l3-interface-ipv6-address + system-type -

IP address

+

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

pathquery string -
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- interface-name + thirdparty-sdnc-id -

Name given to the interface

+

Unique ID of SDNC.

 path @@ -48161,10 +54343,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + esr-system-info-id -

String that identifies the interface

+

Unique ID of esr system info.

 path @@ -48206,17 +54388,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

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

Tags: - CloudInfrastructure + ExternalSystem
-

delete an existing relationship

+

delete an existing esr-system-info

@@ -48238,26 +54420,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 + thirdparty-sdnc-id -

Name that identifies the physical interface

+

Unique ID of SDNC.

 path @@ -48270,10 +54436,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + esr-system-info-id -

Name given to the interface

+

Unique ID of esr system info.

 path @@ -48286,12 +54452,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-version -

String that identifies the interface

+

resource-version for concurrency

pathquery string @@ -48331,13 +54497,13 @@ 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

+

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

Tags: - CloudInfrastructure + ExternalSystem
@@ -48375,10 +54541,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + thirdparty-sdnc-id -

Value from executing hostname on the compute node.

+

Unique ID of SDNC.

 path @@ -48391,10 +54557,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + esr-system-info-id -

Name that identifies the physical interface

+

Unique ID of esr system info.

 path @@ -48436,13 +54602,13 @@ 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

+

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

Tags: - CloudInfrastructure + ExternalSystem
@@ -48468,10 +54634,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- hostname + thirdparty-sdnc-id -

Value from executing hostname on the compute node.

+

Unique ID of SDNC.

 path @@ -48484,10 +54650,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + esr-system-info-id -

Name that identifies the physical interface

+

Unique ID of esr system info.

 path @@ -48529,19 +54695,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-pfs
-

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

+
see node definition for valid relationships
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

returns sriov-pfs

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -48556,26 +54739,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 + thirdparty-sdnc-id -

Name that identifies the physical interface

+

Unique ID of SDNC.

 path @@ -48586,80 +54753,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 - - -
@@ -48669,29 +54762,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-pfs -
-
-
- -
default @@ -48714,19 +54784,24 @@ 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}

+
delete an existing relationship
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

returns sriov-pf

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -48741,42 +54816,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 physical interface

- 		path - string - - - -
- pf-pci-id + thirdparty-sdnc-id -

Identifier for the sriov-pf

+

Unique ID of SDNC.

 path @@ -48787,80 +54830,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 - - -
@@ -48870,29 +54839,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-pf -
-
-
- -
default @@ -48915,105 +54861,48 @@ 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}

+
returns esr-vnfm-list
+

GET /external-system/esr-vnfm-list

Tags: - CloudInfrastructure + ExternalSystem
-

create or update an existing sriov-pf

+

returns esr-vnfm-list

-
- -

application/json application/xml -

-
-
-

sriov-pf object that needs to be created or updated

-

-
-
-
-
- /sriov-pf -
-
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

- 		path - string - - - -
- interface-name - -

Name that identifies the physical interface

- 		path - string - - - -
- pf-pci-id - -

Identifier for the sriov-pf

- 		path - string - - - -
-

application/json application/xml

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-vnfm-list +
+
+
+ +
default @@ -49036,24 +54925,19 @@ 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}

+
returns esr-vnfm
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

delete an existing sriov-pf

+

returns esr-vnfm

-
- -

application/json application/xml -

-
@@ -49068,42 +54952,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 physical interface

- 		path - string - - - -
- pf-pci-id + vnfm-id -

Identifier for the sriov-pf

+

Unique ID of VNFM.

 path @@ -49114,22 +54966,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -49139,6 +54975,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-vnfm +
+
+
+ +
default @@ -49161,17 +55020,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}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+
create or update an existing esr-vnfm
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

see node definition for valid relationships

+

create or update an existing esr-vnfm

@@ -49180,13 +55039,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

+

esr-vnfm object that needs to be created or updated

- /relationship + /esr-vnfm
@@ -49205,42 +55064,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 physical interface

- 		path - string - - - -
- pf-pci-id + vnfm-id -

Identifier for the sriov-pf

+

Unique ID of VNFM.

 path @@ -49282,17 +55109,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}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+
delete an existing esr-vnfm
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

delete an existing relationship

+

delete an existing esr-vnfm

@@ -49314,26 +55141,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 + vnfm-id -

Name that identifies the physical interface

+

Unique ID of VNFM.

 path @@ -49346,12 +55157,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 @@ -49391,36 +55202,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}/relationship-list/relationship

+
returns esr-system-info-list
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

see node definition for valid relationships

+

returns esr-system-info-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -49435,10 +55229,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- hostname + vnfm-id -

Value from executing hostname on the compute node.

+

Unique ID of VNFM.

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-system-info-list +
+
+
+ +
default @@ -49480,24 +55297,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 esr-system-info
+

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

Tags: - CloudInfrastructure + ExternalSystem
-

delete an existing relationship

+

returns esr-system-info

-
- -

application/json application/xml -

-
@@ -49512,10 +55324,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + +
- hostname + vnfm-id -

Value from executing hostname on the compute node.

+

Unique ID of VNFM.

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

Unique ID of esr system info.

 path @@ -49526,6 +55354,36 @@ 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 + +

it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

+ 		query + string + + +
@@ -49535,6 +55393,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /esr-system-info +
+
+
+ +
default @@ -49557,48 +55438,89 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns virtual-data-centers
-

GET /cloud-infrastructure/virtual-data-centers

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

Tags: - CloudInfrastructure + ExternalSystem
-

returns virtual-data-centers

+

create or update an existing esr-system-info

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /esr-system-info +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnfm-id + +

Unique ID of VNFM.

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

Unique ID of esr system info.

+ 		path + string + + + +
+

application/json application/xml

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /virtual-data-centers -
-
-
- -
default @@ -49621,19 +55543,24 @@ 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}

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

Tags: - CloudInfrastructure + ExternalSystem
-

returns virtual-data-center

+

delete an existing esr-system-info

+
+ +

application/json application/xml +

+
@@ -49648,10 +55575,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + @@ -49686,29 +55630,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /virtual-data-center -
-
-
- -
default @@ -49731,17 +55652,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}

+
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

Tags: - CloudInfrastructure + ExternalSystem
-

create or update an existing virtual-data-center

+

see node definition for valid relationships

@@ -49750,13 +55671,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

+

relationship object that needs to be created or updated

- /virtual-data-center + /relationship
@@ -49775,10 +55696,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + + + + + + + +
- vdc-id + vnfm-id -

Unique ID of the vdc

+

Unique ID of VNFM.

 path @@ -49664,10 +55591,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-name + esr-system-info-id -

Name of the virtual data center

+

Unique ID of esr system info.

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

resource-version for concurrency

 query @@ -49675,6 +55618,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- vdc-id + vnfm-id -

Unique ID of the vdc

+

Unique ID of VNFM.

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

Unique ID of esr system info.

 path @@ -49820,17 +55757,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing virtual-data-center
-

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

+
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

Tags: - CloudInfrastructure + ExternalSystem
-

delete an existing virtual-data-center

+

delete an existing relationship

@@ -49852,10 +55789,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + vnfm-id -

Unique ID of the vdc

+

Unique ID of VNFM.

 path @@ -49868,12 +55805,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + esr-system-info-id -

resource-version for concurrency

+

Unique ID of esr system info.

querypath string @@ -49913,13 +55850,13 @@ 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

+

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

Tags: - CloudInfrastructure + ExternalSystem
@@ -49957,10 +55894,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + vnfm-id -

Unique ID of the vdc

+

Unique ID of VNFM.

 path @@ -50002,13 +55939,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

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

+

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

Tags: - CloudInfrastructure + ExternalSystem
@@ -50034,10 +55971,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vdc-id + vnfm-id -

Unique ID of the vdc

+

Unique ID of VNFM.

 path @@ -72480,7 +78417,514 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /instance-group + /instance-group +
+
+ + + +
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + + + + + +
+
+
create or update an existing instance-group
+

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

+ Tags: + Network +
+
+
+

create or update an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+

instance-group object that needs to be created or updated

+

+
+
+
+
+ /instance-group +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing instance-group
+

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

+ Tags: + Network +
+
+
+

delete an existing instance-group

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

resource-version for concurrency

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ id + +

Instance Group ID, UUID assigned to this instance.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ipsec-configurations
+

GET /network/ipsec-configurations

+ Tags: + Network +
+
+
+

returns ipsec-configurations

+ +
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ipsec-configurations +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns ipsec-configuration
+

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

+ Tags: + Network +
+
+
+

returns ipsec-configuration

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

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

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /ipsec-configuration
@@ -72508,17 +78952,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 ipsec-configuration
+

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

Tags: Network
-

create or update an existing instance-group

+

create or update an existing ipsec-configuration

@@ -72527,13 +78971,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

+

ipsec-configuration object that needs to be created or updated

- /instance-group + /ipsec-configuration
@@ -72552,10 +78996,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + ipsec-configuration-id -

Instance Group ID, UUID assigned to this instance.

+

UUID of this configuration

 path @@ -72597,17 +79041,17 @@ 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}

+
delete an existing ipsec-configuration
+

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

Tags: Network
-

delete an existing instance-group

+

delete an existing ipsec-configuration

@@ -72629,10 +79073,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + ipsec-configuration-id -

Instance Group ID, UUID assigned to this instance.

+

UUID of this configuration

 path @@ -72690,11 +79134,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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network
@@ -72734,10 +79178,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + ipsec-configuration-id -

Instance Group ID, UUID assigned to this instance.

+

UUID of this configuration

 path @@ -72779,11 +79223,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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/relationship-list/relationship

Tags: Network
@@ -72811,10 +79255,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- id + ipsec-configuration-id -

Instance Group ID, UUID assigned to this instance.

+

UUID of this configuration

 path @@ -72856,19 +79300,50 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ipsec-configurations
-

GET /network/ipsec-configurations

+
returns vig-servers
+

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

Tags: Network
-

returns ipsec-configurations

+

returns vig-servers

+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + +

UUID of this configuration

+ 		path + string + + + +
+

application/json application/xml @@ -72892,7 +79367,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /ipsec-configurations + /vig-servers
@@ -72920,17 +79395,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 vig-server
+

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

Tags: Network
-

returns ipsec-configuration

+

returns vig-server

@@ -72961,6 +79436,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+ 		path + string + + + +
@@ -72987,7 +79478,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ipsec-configuration + /vig-server
@@ -73015,17 +79506,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 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 ipsec-configuration

+

create or update an existing vig-server

@@ -73034,13 +79525,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

+

vig-server object that needs to be created or updated

- /ipsec-configuration + /vig-server
@@ -73073,6 +79564,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+ 		path + string + + + +
@@ -73104,17 +79611,17 @@ 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}

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

+

delete an existing vig-server

@@ -73150,6 +79657,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+ 		path + string + + + +
resource-version @@ -73197,11 +79720,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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network
@@ -73255,6 +79778,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+ 		path + string + + + +
@@ -73286,11 +79825,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/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Tags: Network
@@ -73332,6 +79871,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ vig-address-type + +

indicates whether the VIG is for AVPN or INTERNET

+ 		path + string + + + +
@@ -73363,50 +79918,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 l3-networks
+

GET /network/l3-networks

Tags: Network
-

returns vig-servers

+

returns l3-networks

-
- - - - - - - - - - - - - - - - - - - -
- ipsec-configuration-id - -

UUID of this configuration

- 		path - string - - - -
-

application/json application/xml @@ -73430,7 +79954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /vig-servers + /l3-networks
@@ -73458,17 +79982,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 l3-network
+

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

Tags: Network
-

returns vig-server

+

returns l3-network

@@ -73485,10 +80009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- ipsec-configuration-id + network-id -

UUID of this configuration

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -73501,18 +80025,137 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vig-address-type + network-name -

indicates whether the VIG is for AVPN or INTERNET

+

Name of the network, governed by some naming convention..

pathquery + 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 -
- ipsec-configuration-id + network-id -

UUID of this configuration

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -73627,12 +80270,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 l3-network
+

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

+ Tags: + Network +
+
+
+

delete an existing l3-network

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + +
- vig-address-type + network-id -

indicates whether the VIG is for AVPN or INTERNET

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -73643,6 +80347,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -73674,24 +80394,19 @@ 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}

+
returns ctag-assignments
+

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

Tags: Network
-

delete an existing vig-server

+

returns ctag-assignments

-
- -

application/json application/xml -

-
@@ -73706,10 +80421,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -73761,6 +80579,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-assignments +
+
+
+ +
default @@ -73783,36 +80624,19 @@ 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

+
returns ctag-assignment
+

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

Tags: Network
-

see node definition for valid relationships

+

returns ctag-assignment

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
- ipsec-configuration-id + network-id -

UUID of this configuration

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -73722,26 +80437,130 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vig-address-type + network-name -

indicates whether the VIG is for AVPN or INTERNET

+

Name of the network, governed by some naming convention..

pathquery string -
- resource-version + network-role -

resource-version for concurrency

+

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 @@ -73749,7 +80568,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -73827,10 +80651,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- ipsec-configuration-id + network-id -

UUID of this configuration

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -73843,20 +80667,155 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vig-address-type + vlan-id-inner -

indicates whether the VIG is for AVPN or INTERNET

+

id.

 path - string + 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 + + +
@@ -73866,6 +80825,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /ctag-assignment +
+
+
+ +
default @@ -73888,23 +80870,35 @@ 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

+
create or update an existing ctag-assignment
+

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

Tags: Network
-

delete an existing relationship

+

create or update an existing ctag-assignment

application/json application/xml

+
+
+

ctag-assignment object that needs to be created or updated

+

+
+
+
+
+ /ctag-assignment +
+
+
@@ -73920,10 +80914,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- ipsec-configuration-id + network-id -

UUID of this configuration

+

Network ID, should be uuid. Unique across A&AI.

 path @@ -73936,14 +80930,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vig-address-type + vlan-id-inner -

indicates whether the VIG is for AVPN or INTERNET

+

id.

 path - string + integer @@ -73981,48 +80975,93 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns l3-networks
-

GET /network/l3-networks

+
delete an existing ctag-assignment
+

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

Tags: Network
-

returns l3-networks

+

delete an existing ctag-assignment

+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+ 		path + string + + + +
+ vlan-id-inner + +

id.

+ 		path + integer + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
+

application/json application/xml

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-networks -
-
-
- -
default @@ -74045,19 +81084,36 @@ 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}

+
see node definition for valid relationships
+

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

Tags: Network
-

returns l3-network

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
@@ -74088,137 +81144,111 @@ 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 + vlan-id-inner -

the ASDC model version for this resource or service model.

+

id.

querypath - string + integer +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l3-network -
-
-
- -
default @@ -74275,17 +81282,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}

+
see node definition for valid relationships
+

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

Tags: Network
-

create or update an existing l3-network

+

see node definition for valid relationships

@@ -74294,13 +81301,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

+

relationship object that needs to be created or updated

- /l3-network + /relationship
@@ -74364,17 +81371,17 @@ 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}

+
delete an existing relationship
+

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

Tags: Network
-

delete an existing l3-network

+

delete an existing relationship

@@ -74410,22 +81417,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- widget-model-id + network-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Network ID, should be uuid. Unique across A&AI.

querypath string +
- widget-model-version + vlan-id-inner -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

id.

querypath - string + integer +
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -74457,17 +81448,17 @@ 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

+
returns segmentation-assignments
+

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

Tags: Network
-

returns ctag-assignments

+

returns segmentation-assignments

@@ -74659,7 +81650,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ctag-assignments + /segmentation-assignments
@@ -74687,17 +81678,17 @@ 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}

+
returns segmentation-assignment
+

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

Tags: Network
-

returns ctag-assignment

+

returns segmentation-assignment

@@ -74730,14 +81721,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + segmentation-id -

id.

+

Route Table Reference id, UUID assigned to this instance.

 path - integer + string @@ -74905,7 +81896,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /ctag-assignment + /segmentation-assignment
@@ -74933,17 +81924,17 @@ 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}

+
create or update an existing segmentation-assignment
+

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

Tags: Network
-

create or update an existing ctag-assignment

+

create or update an existing segmentation-assignment

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

-

ctag-assignment object that needs to be created or updated

+

segmentation-assignment object that needs to be created or updated

- /ctag-assignment + /segmentation-assignment
@@ -74993,14 +81984,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + segmentation-id -

id.

+

Route Table Reference id, UUID assigned to this instance.

 path - integer + string @@ -75038,17 +82029,17 @@ 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}

+
delete an existing segmentation-assignment
+

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

Tags: Network
-

delete an existing ctag-assignment

+

delete an existing segmentation-assignment

@@ -75086,14 +82077,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + segmentation-id -

id.

+

Route Table Reference id, UUID assigned to this instance.

 path - integer + string @@ -75147,11 +82138,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}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+

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

Tags: Network
@@ -75207,14 +82198,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner + segmentation-id -

id.

+

Route Table Reference id, UUID assigned to this instance.

 path - integer + string @@ -75252,11 +82243,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}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

+

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

Tags: Network
@@ -75300,176 +82291,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-id-inner - -

id.

- 		path - integer - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - Network -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- network-id - -

Network ID, should be uuid. Unique across A&AI.

- 		path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - + + + + + + +
- network-id + segmentation-id -

Network ID, should be uuid. Unique across A&AI.

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -75511,17 +82336,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 subnets
+

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

Tags: Network
-

returns segmentation-assignments

+

returns subnets

@@ -75713,7 +82538,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /segmentation-assignments + /subnets
@@ -75741,17 +82566,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 subnet
+

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

Tags: Network
-

returns segmentation-assignment

+

returns subnet

@@ -75784,10 +82609,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + subnet-id -

Route Table Reference id, UUID assigned to this instance.

+

Subnet ID, should be UUID.

 path @@ -75933,6 +82758,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ subnet-name + +

Name associated with the subnet.

+ 		query + string + + +
@@ -75959,7 +82799,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /segmentation-assignment + /subnet
@@ -75987,17 +82827,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 subnet
+

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

Tags: Network
-

create or update an existing segmentation-assignment

+

create or update an existing subnet

@@ -76006,13 +82846,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

+

subnet object that needs to be created or updated

- /segmentation-assignment + /subnet
@@ -76047,10 +82887,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + subnet-id -

Route Table Reference id, UUID assigned to this instance.

+

Subnet ID, should be UUID.

 path @@ -76092,17 +82932,17 @@ 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}

+
delete an existing subnet
+

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

Tags: Network
-

delete an existing segmentation-assignment

+

delete an existing subnet

@@ -76140,10 +82980,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- segmentation-id + subnet-id -

Route Table Reference id, UUID assigned to this instance.

+

Subnet ID, should be UUID.

 path @@ -76201,36 +83041,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}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

+
returns host-routes
+

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

Tags: Network
-

see node definition for valid relationships

+

returns host-routes

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -76261,10 +83084,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
- segmentation-id + subnet-id -

Route Table Reference id, UUID assigned to this instance.

+

Subnet ID, should be UUID.

 path @@ -76275,97 +83098,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.

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

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /host-routes +
+
+
+ +
default @@ -76399,17 +83302,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns subnets
-

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

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

+

returns host-route

@@ -76440,6 +83343,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + + + + + + + + + + + + + + + +
- network-id + network-name -

Network ID, should be uuid. Unique across A&AI.

+

Name of the network, governed by some naming convention..

pathquery string -
- segmentation-id + network-role -

Route Table Reference id, UUID assigned to this instance.

+

Role the network plans - who defines these values?

pathquery + string + + +
+ service-id + +

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

+ 		query + string + + +
+ heat-stack-id + +

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ contrail-network-fqdn + +

Contrail FQDN for the network

+ 		query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+ 		query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+ 		query + string + + +
+ widget-model-id + +

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+ 		query + string + + +
+ widget-model-version + +

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+ 		query + string + + +
+ subnet-name + +

Name associated with the subnet.

+ 		query string -
+ subnet-id + +

Subnet ID, should be UUID.

+ 		path + string + + + +
+ host-route-id + +

host-route id

+ 		path + string + + + +
network-name @@ -76575,6 +83510,21 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ subnet-name + +

Name associated with the subnet.

+ 		query + string + + +
@@ -76601,7 +83551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /subnets + /host-route
@@ -76629,19 +83579,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 host-route
+

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

Tags: Network
-

returns subnet

+

create or update an existing host-route

+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be created or updated

+

+
+
+
+
+ /host-route +
+
+
+
@@ -76688,145 +83655,135 @@ 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 + 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 +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /subnet -
-
-
- -
default @@ -76890,17 +83825,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}

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

+

see node definition for valid relationships

@@ -76909,13 +83844,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

+

relationship object that needs to be created or updated

- /subnet + /relationship
@@ -76964,6 +83899,22 @@ 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 +
- subnet-name + resource-version -

Name associated with the subnet.

+

resource-version for concurrency

 query @@ -76834,6 +83791,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ host-route-id + +

host-route id

+ 		path + string + + + +
@@ -76995,17 +83946,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 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 subnet

+

delete an existing relationship

@@ -77059,12 +84010,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 @@ -85923,10 +92874,532 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

PUT /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + +
+ vnf-id2 + +

Unique id of VNF, can't use same attribute name right now until we promote this new object

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns physical-links
+

GET /network/physical-links

+ Tags: + Network +
+
+
+

returns physical-links

+ +
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

returns physical-link

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

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

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

Circuit it

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

create or update an existing physical-link

+ +
+
+ +

application/json application/xml +

+
+
+

physical-link object that needs to be created or updated

+

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

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

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

delete an existing physical-link

+ +
+
+ +

application/json application/xml +

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

Name given to the interface

+

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

 path @@ -85939,12 +93412,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-version -

String that identifies the interface

+

resource-version for concurrency

pathquery string @@ -85984,11 +93457,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/physical-links/physical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -86028,10 +93501,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + link-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

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

 path @@ -86073,11 +93546,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/physical-links/physical-link/{link-name}/relationship-list/relationship

Tags: Network
@@ -86105,10 +93578,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id2 + link-name -

Unique id of VNF, can't use same attribute name right now until we promote this new object

+

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

 path @@ -86150,17 +93623,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns physical-links
-

GET /network/physical-links

+
returns pnfs
+

GET /network/pnfs

Tags: Network
-

returns physical-links

+

returns pnfs

@@ -86186,7 +93659,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /physical-links + /pnfs
@@ -86214,17 +93687,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns physical-link
-

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

+
returns pnf
+

GET /network/pnfs/pnf/{pnf-name}

Tags: Network
-

returns physical-link

+

returns pnf

@@ -86241,10 +93714,10 @@ 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 @@ -86257,10 +93730,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- circuit-id + inv-status -

Circuit it

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -86296,7 +93769,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /physical-link + /pnf
@@ -86324,17 +93797,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}

+
create or update an existing pnf
+

PUT /network/pnfs/pnf/{pnf-name}

Tags: Network
-

create or update an existing physical-link

+

create or update an existing pnf

@@ -86343,13 +93816,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

+

pnf object that needs to be created or updated

- /physical-link + /pnf
@@ -86368,10 +93841,10 @@ 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 @@ -86413,17 +93886,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing physical-link
-

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

+
delete an existing pnf
+

DELETE /network/pnfs/pnf/{pnf-name}

Tags: Network
-

delete an existing physical-link

+

delete an existing pnf

@@ -86445,10 +93918,10 @@ 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 @@ -86506,17 +93979,283 @@ 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

+
returns lag-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

Tags: Network
-

see node definition for valid relationships

+

returns lag-interfaces

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

create or update an existing lag-interface

@@ -86525,13 +94264,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
@@ -86550,10 +94289,26 @@ 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 @@ -86595,17 +94350,17 @@ 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

+
delete an existing lag-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Tags: Network
-

delete an existing relationship

+

delete an existing lag-interface

@@ -86627,10 +94382,26 @@ 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 @@ -86641,6 +94412,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -86672,19 +94459,111 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns pnfs
-

GET /network/pnfs

+
returns l-interfaces
+

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

Tags: Network
-

returns pnfs

+

returns l-interfaces

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+

application/json application/xml @@ -86708,7 +94587,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

- /pnfs + /l-interfaces
@@ -86736,17 +94615,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 l-interface
+

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

Tags: Network
-

returns pnf

+

returns l-interface

@@ -86777,6 +94656,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 + + + +
inv-status @@ -86792,6 +94703,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 + + +
@@ -86818,7 +94804,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /pnf + /l-interface
@@ -86846,17 +94832,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 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 pnf

+

create or update an existing l-interface

@@ -86865,13 +94851,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

+

l-interface object that needs to be created or updated

- /pnf + /l-interface
@@ -86904,6 +94890,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 + + + +
@@ -86935,17 +94953,17 @@ 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}

+
delete an existing l-interface
+

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

Tags: Network
-

delete an existing pnf

+

delete an existing l-interface

@@ -86981,6 +94999,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 + + + + + + resource-version @@ -87028,17 +95078,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns lag-interfaces
-

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

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

+

returns l3-interface-ipv4-address-list

@@ -87069,6 +95119,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 + + + + + + + + + l3-interface-ipv4-address + + +

IP address

+ + path + + string + + + + + + inv-status @@ -87084,6 +95182,126 @@ 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 + + + + +
@@ -87110,7 +95328,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /lag-interfaces + /l3-interface-ipv4-address-list
@@ -87138,19 +95356,36 @@ 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}

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

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

Tags: Network
-

returns lag-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

+

+
+
+
+
+ /l3-interface-ipv4-address-list +
+
+
+
@@ -87197,47 +95432,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -87249,29 +95471,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /lag-interface -
-
-
- -
default @@ -87294,35 +95493,23 @@ 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}

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

create or update an existing lag-interface

+

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

application/json application/xml

-
-
-

lag-interface object that needs to be created or updated

-

-
-
-
-
- /lag-interface -
-
-
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

- 		query - string - - -
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + l3-interface-ipv4-address -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

IP address

querypath string +
@@ -87368,6 +95555,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 + + + +
@@ -87399,23 +95634,35 @@ 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}

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

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
@@ -87463,12 +95710,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 @@ -87508,19 +95771,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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces

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

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -87567,47 +95835,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + - + @@ -87619,29 +95874,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -87664,17 +95896,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 l3-interface-ipv6-address-list
+

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

Tags: Network
-

returns l-interface

+

returns l3-interface-ipv6-address-list

@@ -87737,6 +95969,22 @@ 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 + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + l3-interface-ipv4-address -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

IP address

querypath string +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
inv-status @@ -87827,6 +96075,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 + + +
@@ -87853,7 +96146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l-interface + /l3-interface-ipv6-address-list
@@ -87881,17 +96174,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 l3-interface-ipv6-address-list
+

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

Tags: Network
-

create or update an existing l-interface

+

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

@@ -87900,13 +96193,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

- /l-interface + /l3-interface-ipv6-address-list
@@ -87971,6 +96264,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -88002,17 +96311,17 @@ 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}

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

+

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

@@ -88080,6 +96389,22 @@ 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 @@ -88127,19 +96452,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}/lag-interfaces/lag-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/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
-

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -88202,7 +96544,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

@@ -88216,139 +96558,129 @@ 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}/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 +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - - - - - - - - + - + @@ -88360,29 +96692,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 @@ -88405,17 +96714,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}/lag-interfaces/lag-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/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 l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -88424,13 +96733,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

- /l3-interface-ipv4-address-list + /relationship
@@ -88495,22 +96804,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 - - -
- 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 + pnf-name -

MAC address for the interface

+

unique name of Physical Network Function.

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the link aggregate interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name given to 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 - -

IP address

- 		path - string - - - -
@@ -88542,17 +96835,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: Network
-

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

+

delete an existing relationship

@@ -88620,38 +96913,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - l3-interface-ipv4-address - - -

IP address

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

resource-version for concurrency

- - query - - string - - - - - -
@@ -88683,36 +96944,19 @@ 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

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

see node definition for valid relationships

+

returns sriov-vfs

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -88775,143 +97019,92 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - -
- l3-interface-ipv4-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 relationship
-

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

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
default @@ -88945,17 +97161,17 @@ 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}

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

+

returns sriov-vf

@@ -89020,10 +97236,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pnf-name + interface-id -

unique name of Physical Network Function.

+

ID of interface

pathquery string -
- interface-name + interface-role -

Name that identifies the link aggregate interface

+

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

pathquery string -
- interface-name + interface-id -

Name given to the interface

+

ID of interface

pathquery string -
- l3-interface-ipv4-address + macaddr -

IP address

+

MAC address for the interface

pathquery + 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 @@ -89126,14 +97342,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 @@ -89141,10 +97357,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 @@ -89156,10 +97372,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 @@ -89195,7 +97426,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /sriov-vf
@@ -89223,17 +97454,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}/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 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 l3-interface-ipv6-address-list

+

create or update an existing sriov-vf

@@ -89242,13 +97473,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

- /l3-interface-ipv6-address-list + /sriov-vf
@@ -89315,10 +97546,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 @@ -89360,17 +97591,17 @@ 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 an existing sriov-vf
+

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

Tags: Network
-

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

+

delete an existing sriov-vf

@@ -89440,10 +97671,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 @@ -89501,11 +97732,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -89593,10 +97824,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 @@ -89638,11 +97869,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -89718,10 +97949,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 @@ -89763,36 +97994,19 @@ 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

+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

see node definition for valid relationships

+

returns vlans

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -89853,6 +98067,96 @@ 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 + + +
@@ -89862,6 +98166,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
default @@ -89884,24 +98211,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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

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

delete an existing relationship

+

returns vlan

-
- -

application/json application/xml -

-
@@ -89962,6 +98284,142 @@ 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 + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ interface-role + +

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
@@ -89971,6 +98429,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -89993,19 +98474,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

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

returns sriov-vfs

+

create or update an existing vlan

+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated

+

+
+
+
+
+ /vlan +
+
+
+
@@ -90068,85 +98566,151 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- inv-status + vlan-interface -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vlan
+

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

+ Tags: + Network +
+
+
+

delete an existing vlan

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vfs -
-
-
- -
default @@ -90210,17 +98752,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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
returns l3-interface-ipv4-address-list
+

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

Tags: Network
-

returns sriov-vf

+

returns l3-interface-ipv4-address-list

@@ -90285,10 +98827,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- interface-id + pnf-name -

ID of interface

+

unique name of Physical Network Function.

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 + 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 +
- network-name + resource-version -

Name of the network

+

resource-version for concurrency

 query @@ -90154,6 +98718,7 @@ 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 @@ -90379,11 +98937,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name -

Name of the network

+

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

 query - string + integer @@ -90391,10 +98964,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-filter + vpn-key -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

This indicates the customers VPN ID associated with this vlan

 query @@ -90406,14 +98979,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-mac-filter + vlan-id-inner -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

Inner VLAN tag

 query - string + integer @@ -90421,14 +98994,14 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vf-vlan-strip + neutron-network-id -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

Neutron network id of the interface that address belongs to

 query - boolean + string @@ -90436,10 +99009,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-network-id + neutron-subnet-id -

Neutron network id of the interface

+

Neutron id of subnet that address belongs to

 query @@ -90475,7 +99048,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vf + /l3-interface-ipv4-address-list
@@ -90503,17 +99076,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}/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-ipv4-address-list
+

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

Tags: Network
-

create or update an existing sriov-vf

+

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

@@ -90522,13 +99095,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-ipv4-address-list object that needs to be created or updated

- /sriov-vf + /l3-interface-ipv4-address-list
@@ -90595,10 +99168,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 @@ -90640,17 +99229,17 @@ 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}

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

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

Tags: Network
-

delete an existing sriov-vf

+

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

@@ -90720,10 +99309,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 @@ -90781,11 +99386,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}/sriov-vfs/sriov-vf/{pci-id}/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
@@ -90873,10 +99478,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 @@ -90918,11 +99539,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}/sriov-vfs/sriov-vf/{pci-id}/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
@@ -90998,10 +99619,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 @@ -91043,17 +99680,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 l3-interface-ipv6-address-list
+

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

Tags: Network
-

returns vlans

+

returns l3-interface-ipv6-address-list

@@ -91116,6 +99753,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 + + + +
inv-status @@ -91206,6 +99875,81 @@ 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 + + +
@@ -91232,7 +99976,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /l3-interface-ipv6-address-list
@@ -91260,19 +100004,36 @@ 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}

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

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

Tags: Network
-

returns vlan

+

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 +
+
+
+
@@ -91351,115 +100112,167 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + +
- inv-status + l3-interface-ipv6-address -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

IP address

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

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -91523,17 +100314,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}

+
see node definition for valid relationships
+

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

Tags: Network
-

create or update an existing vlan

+

see node definition for valid relationships

@@ -91542,13 +100333,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

- /vlan + /relationship
@@ -91629,6 +100420,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- interface-id + pnf-name -

ID of interface

+

unique name of Physical Network Function.

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 + 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 +
- network-name + l3-interface-ipv6-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 @@ -91467,6 +100280,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -91660,17 +100467,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}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
delete an existing relationship
+

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

Tags: Network
-

delete an existing vlan

+

delete an existing relationship

@@ -91756,12 +100563,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 @@ -91801,19 +100608,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}/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 /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
-

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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -91890,12 +100714,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}/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 +

+
+
+ + + + + + + + + + + - + - + - + + +
- l3-interface-ipv4-address + pnf-name -

IP address

+

unique name of Physical Network Function.

 path @@ -91908,160 +100793,328 @@ 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 +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- interface-role + vlan-interface -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + - + + +
- interface-id + pnf-name -

ID of interface

+

unique name of Physical Network Function.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the link aggregate interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

DELETE /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - + + +
- network-name + pnf-name -

Name of the network

+

unique name of Physical Network Function.

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 link aggregate interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interfaces
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

+ Tags: + Network +
+
+
+

returns p-interfaces

+ +
+
+ + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - -
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- neutron-network-id + pnf-name -

Neutron network id of the interface that address belongs to

+

unique name of Physical Network Function.

querypath string +
- neutron-subnet-id + inv-status -

Neutron id of subnet that address belongs to

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

 query @@ -92097,7 +101150,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /p-interfaces
@@ -92125,36 +101178,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns p-interface
+

GET /network/pnfs/pnf/{pnf-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 -
-
-
-
@@ -92188,23 +101224,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - + @@ -92256,6 +101274,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /p-interface +
+
+
+ +
default @@ -92278,23 +101319,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}/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/pnfs/pnf/{pnf-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

+

+
+
+
+
+ /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 @@ -92217,34 +101237,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + inv-status -

String that identifies the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- l3-interface-ipv4-address + prov-status -

IP address

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
@@ -92329,55 +101382,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 @@ -92388,22 +101393,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -92435,35 +101424,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}/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 p-interface
+

DELETE /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Tags: Network
-

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 -
-
-
@@ -92498,39 +101475,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

+

Name that identifies the physical interface

 path @@ -92543,12 +101488,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 @@ -92588,24 +101533,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}/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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: Network
-

delete an existing relationship

+

returns l-interfaces

-
- -

application/json application/xml -

-
@@ -92639,23 +101579,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - + @@ -92707,6 +101629,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /l-interfaces +
+
+
+ +
default @@ -92729,17 +101674,17 @@ 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}

+
returns l-interface
+

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

Tags: Network
-

returns l3-interface-ipv6-address-list

+

returns l-interface

@@ -92775,7 +101720,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 @@ -92668,34 +101592,32 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + inv-status -

String that identifies the interface

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

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 @@ -92802,38 +101747,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 - - - -
inv-status @@ -92851,25 +101764,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 @@ -92924,81 +101822,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 - - -
@@ -93025,7 +101848,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /l-interface
@@ -93053,17 +101876,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}/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/pnfs/pnf/{pnf-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

@@ -93072,13 +101895,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

- /l3-interface-ipv6-address-list + /l-interface
@@ -93116,7 +101939,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 @@ -93143,12 +101966,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 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 @@ -93161,10 +102045,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 physical interface

 path @@ -93175,6 +102059,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 + + + +
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -93206,24 +102122,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/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l3-interface-ipv4-address-list
+

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

Tags: Network
-

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

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -93257,7 +102168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -93341,6 +102340,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 @@ -93363,17 +102385,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

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

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

Tags: Network
-

see node definition for valid relationships

+

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

@@ -93382,13 +102404,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
@@ -93426,7 +102448,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 @@ -93286,10 +102197,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 @@ -93302,26 +102213,115 @@ 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 -
- resource-version + prov-status -

resource-version for concurrency

+

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -93329,7 +102329,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
-

Name that identifies the link aggregate interface

+

Name that identifies the physical interface

 path @@ -93455,23 +102477,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

@@ -93516,17 +102522,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-ipv4-address-list
+

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

Tags: Network
-

delete an existing relationship

+

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

@@ -93567,7 +102573,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 @@ -93596,10 +102602,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 @@ -93612,12 +102618,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 @@ -93657,11 +102663,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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -93720,7 +102726,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 @@ -93749,10 +102755,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 @@ -93794,11 +102800,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-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -93845,7 +102851,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 @@ -93874,10 +102880,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 @@ -93919,36 +102925,19 @@ 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

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

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -93982,7 +102971,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 @@ -93993,73 +102982,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}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - -
- pnf-name + interface-name -

unique name of Physical Network Function.

+

Name given to the interface

 path @@ -94072,10 +103000,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv6-address -

Name that identifies the link aggregate interface

+

IP address

 path @@ -94086,84 +103014,117 @@ 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

- -
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- pnf-name + inv-status -

unique name of Physical Network Function.

+

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

pathquery string -
- inv-status + prov-status -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

 query @@ -94199,7 +103160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /p-interfaces + /l3-interface-ipv6-address-list
@@ -94227,19 +103188,36 @@ 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}

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

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

Tags: Network
-

returns p-interface

+

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 +
+
+
+
@@ -94286,32 +103264,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -94323,29 +103303,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /p-interface -
-
-
- -
default @@ -94368,35 +103325,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

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

create or update an existing p-interface

+

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

application/json application/xml

-
-
-

p-interface object that needs to be created or updated

-

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

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
@@ -94442,6 +103387,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-ipv6-address + +

IP address

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

resource-version for concurrency

+ 		query + string + + + +
@@ -94473,23 +103466,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}

+
see node definition for valid relationships
+

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

Tags: Network
-

delete an existing p-interface

+

see node definition for valid relationships

application/json application/xml

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
@@ -94537,12 +103542,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 @@ -94582,19 +103603,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 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
-

returns l-interfaces

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -94641,32 +103667,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + @@ -94678,29 +103706,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interfaces -
-
-
- -
default @@ -94723,19 +103728,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}/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

+

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

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
@@ -94796,81 +103818,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 - - -
@@ -94880,29 +103827,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /l-interface -
-
-
- -
default @@ -94925,35 +103849,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}/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 -
-
-
@@ -95046,24 +103958,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 sriov-vfs
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: Network
-

delete an existing l-interface

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -95126,10 +104033,70 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -95149,6 +104115,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vfs +
+
+
+ +
default @@ -95171,17 +104160,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 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 l3-interface-ipv4-address-list

+

returns sriov-vf

@@ -95246,10 +104235,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 @@ -95137,7 +104104,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -95337,14 +104326,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 @@ -95352,10 +104341,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 @@ -95367,10 +104356,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 @@ -95406,7 +104410,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /sriov-vf
@@ -95434,17 +104438,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 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 l3-interface-ipv4-address-list

+

create or update an existing sriov-vf

@@ -95453,13 +104457,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-vf object that needs to be created or updated

- /l3-interface-ipv4-address-list + /sriov-vf
@@ -95526,10 +104530,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -95571,17 +104575,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing 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 l3-interface-ipv4-address-list

+

delete an existing sriov-vf

@@ -95651,10 +104655,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -95712,11 +104716,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}/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -95804,10 +104808,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -95849,11 +104853,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}/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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: Network
@@ -95929,10 +104933,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + pci-id -

IP address

+

PCI ID used to identify the sriov-vf

 path @@ -95974,17 +104978,17 @@ 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns vlans
+

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: Network
-

returns l3-interface-ipv6-address-list

+

returns vlans

@@ -96049,10 +105053,212 @@ 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.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vlan
+

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

+ Tags: + Network +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - - - - - + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

 path @@ -96155,25 +105361,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 @@ -96209,7 +105400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /vlan
@@ -96237,17 +105428,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 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-ipv6-address-list

+

create or update an existing vlan

@@ -96256,13 +105447,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

+

vlan object that needs to be created or updated

- /l3-interface-ipv6-address-list + /vlan
@@ -96329,10 +105520,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 @@ -96374,17 +105565,17 @@ 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}

+
delete an existing vlan
+

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

Tags: Network
-

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

+

delete an existing vlan

@@ -96454,10 +105645,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 @@ -96515,17 +105706,326 @@ 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

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

see node definition for valid relationships

+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ pnf-name + +

unique name of Physical Network Function.

+ 		path + string + + + +
+ interface-name + +

Name that identifies the physical interface

+ 		path + string + + + +
+ interface-name + +

Name given to the interface

+ 		path + string + + + +
+ vlan-interface + +

String that identifies the interface

+ 		path + string + + + +
+ l3-interface-ipv4-address + +

IP address

+ 		path + string + + + +
+ inv-status + +

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+ 		query + string + + +
+ prov-status + +

Trigger for operational monitoring of this resource by Service Assurance systems.

+ 		query + string + + +
+ interface-id + +

ID of interface

+ 		query + string + + +
+ macaddr + +

MAC address for the interface

+ 		query + string + + +
+ network-name + +

Name of the network

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ vpn-key + +

This indicates the customers VPN ID associated with this vlan

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query + string + + +
+
+ +
+

application/json application/xml +

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

successful operation

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

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

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

@@ -96534,13 +106034,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
@@ -96607,7 +106107,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

@@ -96652,17 +106168,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}/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
-

delete an existing relationship

+

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

@@ -96732,7 +106248,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

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

resource-version for concurrency

+ 		query + string + + + +
@@ -96777,11 +106325,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
@@ -96867,6 +106415,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-ipv4-address + +

IP address

+ 		path + string + + + +
@@ -96898,11 +106478,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}/relationship-list/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
@@ -96976,6 +106556,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-ipv4-address + +

IP address

+ 		path + string + + + +
@@ -97007,17 +106619,17 @@ 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

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

+

returns l3-interface-ipv6-address-list

@@ -97080,6 +106692,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 + + + +
inv-status @@ -97155,6 +106799,81 @@ 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 + + +
@@ -97181,7 +106900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-vfs + /l3-interface-ipv6-address-list
@@ -97209,19 +106928,36 @@ 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}

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

returns sriov-vf

+

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 +
+
+
+
@@ -97284,10 +107020,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 @@ -97300,130 +107036,167 @@ 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 + l3-interface-ipv6-address -

ID of interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + Network +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - + - + - + - + @@ -97442,29 +107216,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -97487,17 +107238,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}

+
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
-

create or update an existing sriov-vf

+

see node definition for valid relationships

@@ -97506,13 +107257,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

+

relationship object that needs to be created or updated

- /sriov-vf + /relationship
@@ -97579,10 +107330,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- macaddr + pnf-name -

MAC address for the interface

+

unique name of Physical Network Function.

querypath string +
- network-name + interface-name -

Name of the network

+

Name that identifies the physical interface

querypath string +
- vf-vlan-filter + interface-name -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Name given to the interface

querypath string +
- vf-mac-filter + vlan-interface -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

+

String that identifies the interface

querypath string +
- vf-vlan-strip + l3-interface-ipv6-address -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

IP address

querypath - boolean + string +
- neutron-network-id + resource-version -

Neutron network id of the interface

+

resource-version for concurrency

 query @@ -97431,6 +107204,7 @@ 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 @@ -97624,17 +107391,17 @@ 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}/p-interfaces/p-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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing sriov-vf

+

delete an existing relationship

@@ -97704,10 +107471,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 @@ -97720,12 +107487,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 @@ -97765,11 +107532,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}/sriov-vfs/sriov-vf/{pci-id}/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}/relationship-list/relationship

Tags: Network
@@ -97857,10 +107624,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 @@ -97902,11 +107669,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/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
@@ -97982,10 +107749,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 @@ -98027,19 +107794,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}/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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -98084,12 +107868,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 + pnf-name -

Name given to the interface

+

unique name of Physical Network Function.

 path @@ -98102,55 +107947,114 @@ 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 +
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 @@ -98162,10 +108066,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 @@ -98201,7 +108105,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlans + /sriov-pfs
@@ -98229,17 +108133,17 @@ 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}

+
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 vlan

+

returns sriov-pf

@@ -98288,26 +108192,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 @@ -98348,81 +108236,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 - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

- 		query - string - - -
@@ -98449,7 +108262,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vlan + /sriov-pf
@@ -98477,17 +108290,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}

+
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 vlan

+

create or update an existing sriov-pf

@@ -98496,13 +108309,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

+

sriov-pf object that needs to be created or updated

- /vlan + /sriov-pf
@@ -98553,26 +108366,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 @@ -98614,17 +108411,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 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 vlan

+

delete an existing sriov-pf

@@ -98678,26 +108475,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 @@ -98755,19 +108536,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}/sriov-pfs/sriov-pf/{pf-pci-id}/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

+

+
+
+
+
+ /relationship +
+
+
+
@@ -98814,10 +108612,10 @@ 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 @@ -98828,12 +108626,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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + + +
- vlan-interface + pnf-name -

String that identifies the interface

+

unique name of Physical Network Function.

 path @@ -98846,10 +108705,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 @@ -98862,145 +108721,328 @@ 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 + pf-pci-id -

MAC address for the interface

+

Identifier for the sriov-pf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + - + + +
- network-name + pnf-name -

Name of the network

+

unique name of Physical Network Function.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - + + +
- vlan-id-inner - -

Inner VLAN tag

- 		query - integer - - -
- vpn-key + pnf-name -

This indicates the customers VPN ID associated with this vlan

+

unique name of Physical Network Function.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-table-references
+

GET /network/route-table-references

+ Tags: + Network +
+
+
+

returns route-table-references

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /route-table-references +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns route-table-reference
+

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

+ Tags: + Network +
+
+
+

returns route-table-reference

+ +
+
+ + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 +
- neutron-subnet-id + route-table-reference-fqdn -

Neutron id of subnet that address belongs to

+

FQDN entry in the route table.

 query @@ -99036,7 +109078,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv4-address-list + /route-table-reference
@@ -99064,17 +109106,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 route-table-reference
+

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

create or update an existing l3-interface-ipv4-address-list

+

create or update an existing route-table-reference

@@ -99083,13 +109125,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

+

route-table-reference object that needs to be created or updated

- /l3-interface-ipv4-address-list + /route-table-reference
@@ -99108,74 +109150,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-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -99217,17 +109195,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing route-table-reference
+

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

Tags: Network
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing route-table-reference

@@ -99249,74 +109227,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-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -99374,11 +109288,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/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network
@@ -99418,74 +109332,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-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -99527,11 +109377,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/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Tags: Network
@@ -99559,74 +109409,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-ipv4-address + route-table-reference-id -

IP address

+

Route Table Reference id, UUID assigned to this instance.

 path @@ -99668,17 +109454,81 @@ 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}

+
returns site-pair-sets
+

GET /network/site-pair-sets

Tags: Network
-

returns l3-interface-ipv6-address-list

+

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

@@ -99695,74 +109545,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 @@ -99773,156 +109559,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 - -

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 - - -
@@ -99949,7 +109585,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /l3-interface-ipv6-address-list + /site-pair-set
@@ -99977,17 +109613,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}/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
-

create or update an existing l3-interface-ipv6-address-list

+

create or update an existing site-pair-set

@@ -99996,13 +109632,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

+

site-pair-set object that needs to be created or updated

- /l3-interface-ipv6-address-list + /site-pair-set
@@ -100021,74 +109657,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 @@ -100130,17 +109702,17 @@ 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}

+
delete an existing site-pair-set
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Tags: Network
-

delete an existing l3-interface-ipv6-address-list

+

delete an existing site-pair-set

@@ -100162,74 +109734,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 @@ -100287,11 +109795,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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network
@@ -100331,74 +109839,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 @@ -100440,11 +109884,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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Tags: Network
@@ -100472,26 +109916,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 @@ -100502,12 +109930,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 given to the interface

+

Unique id of site pair set.

 path @@ -100518,12 +110002,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

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - -
- vlan-interface + site-pair-set-id -

String that identifies the interface

+

Unique id of site pair set.

 path @@ -100536,10 +110099,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + routing-instance-id -

IP address

+

Unique id of routing instance

 path @@ -100559,6 +110122,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /routing-instance +
+
+
+ +
default @@ -100581,17 +110167,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}/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

@@ -100600,13 +110186,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

- /relationship + /routing-instance
@@ -100625,42 +110211,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 + site-pair-set-id -

Name given to the interface

+

Unique id of site pair set.

 path @@ -100673,10 +110227,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 @@ -100718,17 +110272,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}/relationship-list/relationship

+
delete an existing routing-instance
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}

Tags: Network
-

delete an existing relationship

+

delete an existing routing-instance

@@ -100750,26 +110304,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 @@ -100782,10 +110320,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + routing-instance-id -

Name given to the interface

+

Unique id of routing instance

 path @@ -100798,12 +110336,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + resource-version -

String that identifies the interface

+

resource-version for concurrency

pathquery string @@ -100843,11 +110381,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}/relationship-list/relationship

+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

Tags: Network
@@ -100887,10 +110425,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 @@ -100903,10 +110441,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 @@ -100948,11 +110486,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}/relationship-list/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
@@ -100980,10 +110518,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 @@ -100996,10 +110534,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 @@ -101041,17 +110579,17 @@ 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

+
returns site-pairs
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs

Tags: Network
-

returns sriov-pfs

+

returns site-pairs

@@ -101068,10 +110606,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 @@ -101084,10 +110622,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 @@ -101098,36 +110636,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 - - -
@@ -101154,7 +110662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-pfs + /site-pairs
@@ -101182,17 +110690,17 @@ 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}

+
returns site-pair
+

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network
-

returns sriov-pf

+

returns site-pair

@@ -101209,10 +110717,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 @@ -101225,10 +110733,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 @@ -101241,10 +110749,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 @@ -101255,36 +110763,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 - - -
@@ -101311,7 +110789,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /sriov-pf + /site-pair
@@ -101339,17 +110817,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/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+
create or update an existing site-pair
+

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network
-

create or update an existing sriov-pf

+

create or update an existing site-pair

@@ -101358,13 +110836,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

+

site-pair object that needs to be created or updated

- /sriov-pf + /site-pair
@@ -101383,10 +110861,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 @@ -101399,10 +110877,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 @@ -101415,10 +110893,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 @@ -101460,17 +110938,17 @@ 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}

+
delete an existing site-pair
+

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

Tags: Network
-

delete an existing sriov-pf

+

delete an existing site-pair

@@ -101492,10 +110970,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 @@ -101508,10 +110986,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 @@ -101524,10 +111002,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 @@ -101585,36 +111063,19 @@ 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

+
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
-

see node definition for valid relationships

+

returns classes-of-service

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -101629,10 +111090,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 @@ -101645,10 +111106,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 @@ -101661,10 +111122,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 @@ -101684,6 +111145,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /classes-of-service +
+
+
+ +
default @@ -101706,24 +111190,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}/sriov-pfs/sriov-pf/{pf-pci-id}/relationship-list/relationship

+
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
-

delete an existing relationship

+

returns class-of-service

-
- -

application/json application/xml -

-
@@ -101738,10 +111217,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 @@ -101754,10 +111233,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 @@ -101770,10 +111249,26 @@ 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 + string + + + +
+ cos + +

unique identifier of probe

 path @@ -101793,6 +111288,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /class-of-service +
+
+
+ +
default @@ -101815,17 +111333,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}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing class-of-service

@@ -101834,13 +111352,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
@@ -101859,10 +111377,58 @@ 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 + string + + + +
+ cos + +

unique identifier of probe

 path @@ -101904,17 +111470,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}/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

@@ -101936,10 +111502,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 @@ -101950,132 +111516,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 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

- -
-
- - - - - - - - - - - + + + + + + + + + + + + + + @@ -102110,29 +111589,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /route-table-reference -
-
-
- -
default @@ -102155,17 +111611,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}

+
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 route-table-reference

+

see node definition for valid relationships

@@ -102174,13 +111630,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

+

relationship object that needs to be created or updated

- /route-table-reference + /relationship
@@ -102199,10 +111655,58 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + + + + + + + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- route-table-reference-id + routing-instance-id -

Route Table Reference id, UUID assigned to this instance.

+

Unique id of routing instance

 path @@ -102088,10 +111534,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- route-table-reference-fqdn + site-pair-id -

FQDN entry in the route table.

+

unique identifier of probe

+ 		path + string + + + +
+ cos + +

unique identifier of probe

+ 		path + string + + + +
+ resource-version + +

resource-version for concurrency

 query @@ -102099,6 +111577,7 @@ 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 @@ -102244,17 +111748,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing route-table-reference
-

DELETE /network/route-table-references/route-table-reference/{route-table-reference-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 route-table-reference

+

delete an existing relationship

@@ -102276,10 +111780,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 @@ -102292,12 +111796,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 @@ -102337,11 +111873,11 @@ 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

+

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
@@ -102381,10 +111917,42 @@ 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 @@ -102426,11 +111994,11 @@ 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 /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
@@ -102458,10 +112026,42 @@ 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 @@ -102503,17 +112103,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns site-pair-sets
-

GET /network/site-pair-sets

+
returns vces
+

GET /network/vces

Tags: Network
-

returns site-pair-sets

+

returns vces

@@ -102539,7 +112139,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /site-pair-sets + /vces
@@ -102567,17 +112167,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns site-pair-set
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

+
returns vce
+

GET /network/vces/vce/{vnf-id}

Tags: Network
-

returns site-pair-set

+

returns vce

@@ -102594,10 +112194,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 @@ -102608,201 +112208,117 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pair-set -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing site-pair-set
-

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

- Tags: - Network -
-
-
-

create or update an existing site-pair-set

- -
-
- -

application/json application/xml -

-
-
-

site-pair-set object that needs to be created or updated

-

-
-
-
-
- /site-pair-set -
-
-
-
-
- - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - -
- site-pair-set-id + vnf-name -

Unique id of site pair set.

+

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 -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing site-pair-set
-

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

- Tags: - Network -
-
-
-

delete an existing site-pair-set

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + + + + + + + + @@ -102822,6 +112337,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vce +
+
+
+ +
default @@ -102844,17 +112382,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}/relationship-list/relationship

+
create or update an existing vce
+

PUT /network/vces/vce/{vnf-id}

Tags: Network
-

see node definition for valid relationships

+

create or update an existing vce

@@ -102863,13 +112401,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

+

vce object that needs to be created or updated

- /relationship + /vce
@@ -102888,10 +112426,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ + + + + + +
- site-pair-set-id + prov-status -

Unique id of site pair set.

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- resource-version + heat-stack-id -

resource-version for concurrency

+

Heat stack id corresponding to this instance, managed by MSO

+ 		query + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

 query @@ -102810,7 +112326,6 @@ 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 @@ -102933,17 +112471,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}/relationship-list/relationship

+
delete an existing vce
+

DELETE /network/vces/vce/{vnf-id}

Tags: Network
-

delete an existing relationship

+

delete an existing vce

@@ -102965,10 +112503,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 @@ -102979,6 +112517,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+ 		query + string + + + +
@@ -103010,17 +112564,17 @@ 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 entitlements
+

GET /network/vces/vce/{vnf-id}/entitlements

Tags: Network
-

returns routing-instances

+

returns entitlements

@@ -103037,10 +112591,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 @@ -103051,6 +112605,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 + + +
@@ -103077,7 +112751,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /routing-instances + /entitlements
@@ -103105,17 +112779,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 entitlement
+

GET /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

returns routing-instance

+

returns entitlement

@@ -103132,10 +112806,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 @@ -103148,10 +112822,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 @@ -103162,6 +112852,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 + + +
@@ -103188,7 +112998,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /routing-instance + /entitlement
@@ -103216,17 +113026,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 entitlement
+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

create or update an existing routing-instance

+

create or update an existing entitlement

@@ -103235,13 +113045,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

+

entitlement object that needs to be created or updated

- /routing-instance + /entitlement
@@ -103260,10 +113070,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 @@ -103276,10 +113086,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 @@ -103321,17 +113147,17 @@ 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}

+
delete an existing entitlement
+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing routing-instance

+

delete an existing entitlement

@@ -103353,10 +113179,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 @@ -103369,10 +113195,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 @@ -103430,11 +113272,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}/relationship-list/relationship

+

PUT /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -103474,10 +113316,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 @@ -103490,10 +113332,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 @@ -103535,11 +113393,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}/relationship-list/relationship

+

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -103567,10 +113425,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 @@ -103583,10 +113441,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 @@ -103628,17 +113502,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 licenses
+

GET /network/vces/vce/{vnf-id}/licenses

Tags: Network
-

returns site-pairs

+

returns licenses

@@ -103655,10 +113529,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 @@ -103671,289 +113545,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.

- path + query string - - - -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pairs -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns site-pair
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

- Tags: - Network -
-
-
-

returns site-pair

- -
-
- - - - - - - - - - - - + - + - + - -
- site-pair-set-id + vnf-name2 -

Unique id of site pair set.

+

Alternate name of VNF.

pathquery string -
- routing-instance-id + vnf-type -

Unique id of routing instance

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 -
- site-pair-id + service-id -

unique identifier of probe

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /site-pair -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing site-pair
-

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}

- Tags: - Network -
-
-
-

create or update an existing site-pair

- -
-
- -

application/json application/xml -

-
-
-

site-pair object that needs to be created or updated

-

-
-
-
-
- /site-pair -
-
-
-
-
- - - - - - - - - - - - + - + - + + + + + + + + @@ -103965,6 +113672,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /licenses +
+
+
+ +
default @@ -103987,24 +113717,19 @@ 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}

+
returns license
+

GET /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing site-pair

+

returns license

-
- -

application/json application/xml -

-
- site-pair-set-id + regional-resource-zone -

Unique id of site pair set.

+

Regional way of organizing pservers, source of truth should define values

pathquery string -
- routing-instance-id + prov-status -

Unique id of routing instance

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- site-pair-id + heat-stack-id -

unique identifier of probe

+

Heat stack id corresponding to this instance, managed by MSO

pathquery + string + + +
+ vpe-id + +

Unique ID of VPE connected to this VCE.

+ 		query string -
@@ -104019,10 +113744,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 @@ -104035,10 +113760,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 @@ -104051,10 +113776,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 @@ -104067,10 +113792,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vnf-name -

resource-version for concurrency

+

Name of VNF.

 query @@ -104078,254 +113803,111 @@ 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 classes-of-service
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

- Tags: - Network -
-
-
-

returns classes-of-service

- -
-
- - - - - - - - - - - - + - + - + - -
- site-pair-set-id + vnf-name2 -

Unique id of site pair set.

+

Alternate name of VNF.

pathquery string -
- routing-instance-id + vnf-type -

Unique id of routing instance

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 -
- site-pair-id + service-id -

unique identifier of probe

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /classes-of-service -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns class-of-service
-

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}

- Tags: - Network -
-
-
-

returns class-of-service

- -
-
- - - - - - - - - - - - + - + - + - + @@ -104354,7 +113936,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /class-of-service + /license
@@ -104382,17 +113964,17 @@ 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}

+
create or update an existing license
+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

create or update an existing class-of-service

+

create or update an existing license

@@ -104401,13 +113983,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

class-of-service object that needs to be created or updated

+

license object that needs to be created or updated

- /class-of-service + /license
@@ -104426,26 +114008,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- site-pair-set-id + regional-resource-zone -

Unique id of site pair set.

+

Regional way of organizing pservers, source of truth should define values

pathquery string -
- routing-instance-id + prov-status -

Unique id of routing instance

+

Trigger for operational monitoring of this resource by Service Assurance systems.

pathquery string -
- site-pair-id + heat-stack-id -

unique identifier of probe

+

Heat stack id corresponding to this instance, managed by MSO

pathquery string -
- cos + vpe-id -

unique identifier of probe

+

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 @@ -104458,10 +114024,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 @@ -104474,10 +114040,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 @@ -104519,17 +114085,17 @@ 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}

+
delete an existing license
+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}

Tags: Network
-

delete an existing class-of-service

+

delete an existing license

@@ -104551,26 +114117,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 @@ -104583,10 +114133,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 @@ -104599,10 +114149,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 @@ -104660,11 +114210,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}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

+

PUT /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -104704,26 +114254,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 @@ -104736,10 +114270,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 @@ -104752,10 +114286,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 @@ -104797,11 +114331,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}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

+

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Tags: Network
@@ -104829,26 +114363,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 @@ -104861,10 +114379,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 @@ -104877,10 +114395,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 @@ -104922,36 +114440,19 @@ 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

+
returns port-groups
+

GET /network/vces/vce/{vnf-id}/port-groups

Tags: Network
-

see node definition for valid relationships

+

returns port-groups

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -104966,10 +114467,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 @@ -104982,190 +114483,128 @@ 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 -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - + - + + + + + + + + + + + + + + + + + + + + + +
- site-pair-set-id + vnf-type -

Unique id of site pair set.

+

String capturing type of vnf, that was intended to identify the ASDC resource. This 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 -
- routing-instance-id + service-id -

Unique id of routing instance

+

Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.

pathquery string -
- site-pair-id + regional-resource-zone -

unique identifier of probe

+

Regional way of organizing pservers, source of truth should define values

pathquery + 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 -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns vces
-

GET /network/vces

- Tags: - Network -
-
-
-

returns vces

- -
-

application/json application/xml

@@ -105188,7 +114627,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vces + /port-groups
@@ -105216,17 +114655,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

@@ -105257,6 +114696,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 @@ -105377,6 +114832,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 + + +
@@ -105403,7 +114903,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /vce + /port-group
@@ -105431,17 +114931,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

@@ -105450,13 +114950,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

- /vce + /port-group
@@ -105489,6 +114989,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 + + + + + +
@@ -105520,17 +115036,17 @@ 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}

+
delete an existing port-group
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}

Tags: Network
-

delete an existing vce

+

delete an existing port-group

@@ -105566,6 +115082,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 + + + + + + resource-version @@ -105613,17 +115145,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

@@ -105654,6 +115186,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 @@ -105774,6 +115322,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 + + + + +
@@ -105800,7 +115393,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlements + /cvlan-tags
@@ -105828,17 +115421,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

@@ -105871,10 +115464,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 @@ -105887,14 +115480,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 @@ -106021,6 +115614,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 + + + + +
@@ -106047,7 +115685,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /entitlement + /cvlan-tag-entry
@@ -106075,17 +115713,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
create or update an existing entitlement
-

PUT /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
-

create or update an existing entitlement

+

create or update an existing cvlan-tag-entry

@@ -106094,13 +115732,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

+

cvlan-tag-entry object that needs to be created or updated

- /entitlement + /cvlan-tag-entry
@@ -106135,10 +115773,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 @@ -106151,14 +115789,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 @@ -106196,17 +115834,17 @@ 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}

+
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 entitlement

+

delete an existing cvlan-tag-entry

@@ -106244,10 +115882,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 @@ -106260,14 +115898,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 @@ -106321,11 +115959,241 @@ 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

+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

+ Tags: + Network +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated

+

+
+
+
+
+ /relationship +
+
+
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of the interface

+ 		path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id + +

Unique ID of the interface

+ 		path + string + + + +
+ cvlan-tag + +

See mis-na-virtualization-platform.yang

+ 		path + integer + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Tags: Network
@@ -106381,26 +116249,103 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - group-uuid - - -

Unique ID for the entitlement group the resource comes from, should be uuid.

- - path - - string - - - - - - - - - resource-uuid + interface-id + + +

Unique ID of the interface

+ + path + + string + + + + + + + + + + +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

+ Tags: + Network +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
+ vnf-id + +

Unique id of VNF. This is unique across the graph.

+ 		path + string + + + +
+ interface-id -

Unique ID of an entitlement resource.

+

Unique ID of the interface

 path @@ -106442,23 +116387,35 @@ 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

+
see node definition for valid relationships
+

PUT /network/vces/vce/{vnf-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

+

+
+
+
+
+ /relationship +
+
+
@@ -106488,38 +116445,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - -
- 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 - - - -
@@ -106551,19 +116476,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
returns licenses
-

GET /network/vces/vce/{vnf-id}/licenses

+
delete an existing relationship
+

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

Tags: Network
-

returns licenses

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -106592,126 +116522,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 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 - - -
@@ -106721,29 +116531,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /licenses -
-
-
- -
default @@ -106766,17 +116553,17 @@ 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}

+
returns vip-ipv4-address-list
+

GET /network/vip-ipv4-address-list/{vip-ipv4-address}

Tags: Network
-

returns license

+

returns vip-ipv4-address-list

@@ -106793,42 +116580,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 + vip-ipv4-address -

Unique ID of a license resource.

+

IP address

 path @@ -106841,89 +116596,14 @@ 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 + vlan-id-inner -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Inner VLAN tag

 query - string + integer @@ -106931,10 +116611,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 instance, managed by MSO

+

Neutron network id of the interface that address belongs to

 query @@ -106946,10 +116626,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + neutron-subnet-id -

Unique ID of VPE connected to this VCE.

+

Neutron id of subnet that address belongs to

 query @@ -106985,7 +116665,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /license + /vip-ipv4-address-list
@@ -107013,17 +116693,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}

+
create or update an existing vip-ipv4-address-list
+

PUT /network/vip-ipv4-address-list/{vip-ipv4-address}

Tags: Network
-

create or update an existing license

+

create or update an existing vip-ipv4-address-list

@@ -107032,13 +116712,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

+

vip-ipv4-address-list object that needs to be created or updated

- /license + /vip-ipv4-address-list
@@ -107057,42 +116737,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 + vip-ipv4-address -

Unique ID of a license resource.

+

IP address

 path @@ -107134,17 +116782,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 vip-ipv4-address-list
+

DELETE /network/vip-ipv4-address-list/{vip-ipv4-address}

Tags: Network
-

delete an existing license

+

delete an existing vip-ipv4-address-list

@@ -107166,42 +116814,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 + vip-ipv4-address -

Unique ID of a license resource.

+

IP address

 path @@ -107259,11 +116875,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/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -107303,42 +116919,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 + vip-ipv4-address -

Unique ID of a license resource.

+

IP address

 path @@ -107380,11 +116964,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/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -107412,42 +116996,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 + vip-ipv4-address -

Unique ID of a license resource.

+

IP address

 path @@ -107489,17 +117041,17 @@ 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 vip-ipv6-address-list
+

GET /network/vip-ipv6-address-list/{vip-ipv6-address}

Tags: Network
-

returns port-groups

+

returns vip-ipv6-address-list

@@ -107516,10 +117068,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-id + vip-ipv6-address -

Unique id of VNF. This is unique across the graph.

+

IP address

 path @@ -107532,89 +117084,14 @@ 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 + vlan-id-inner -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Inner VLAN tag

 query - string + integer @@ -107622,10 +117099,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 instance, managed by MSO

+

Neutron network id of the interface that address belongs to

 query @@ -107637,10 +117114,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vpe-id + neutron-subnet-id -

Unique ID of VPE connected to this VCE.

+

Neutron id of subnet that address belongs to

 query @@ -107676,7 +117153,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /port-groups + /vip-ipv6-address-list
@@ -107704,19 +117181,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 vip-ipv6-address-list
+

PUT /network/vip-ipv6-address-list/{vip-ipv6-address}

Tags: Network
-

returns port-group

+

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

+

+
+
+
+
+ /vip-ipv6-address-list +
+
+
+
@@ -107731,10 +117225,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vnf-id + vip-ipv6-address -

Unique id of VNF. This is unique across the graph.

+

IP address

 path @@ -107745,12 +117239,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 vip-ipv6-address-list
+

DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}

+ Tags: + Network +
+
+
+

delete an existing vip-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -107935,29 +117341,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /port-group -
-
-
- -
default @@ -107980,17 +117363,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}

+
see node definition for valid relationships
+

PUT /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

Tags: Network
-

create or update an existing port-group

+

see node definition for valid relationships

@@ -107999,13 +117382,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

+

relationship object that needs to be created or updated

- /port-group + /relationship
@@ -108024,26 +117407,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - -
- interface-id + vip-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -107763,160 +117318,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 - -

Heat stack id corresponding to this instance, managed by MSO

- 		query - string - - -
- vpe-id - -

Unique ID of VPE connected to this VCE.

- 		query - string - - -
- port-group-id - -

Unique ID for port group in vmware

- 		query - string - - -
- switch-name - -

DVS or standard switch name (should be non-null for port groups associated with DVS)

- 		query - string - - -
- heat-stack-id + resource-version -

Heat stack id corresponding to this instance, managed by MSO

+

resource-version for concurrency

 query @@ -107924,6 +117329,7 @@ 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 + vip-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -108085,17 +117452,17 @@ 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}

+
delete an existing relationship
+

DELETE /network/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

Tags: Network
-

delete an existing port-group

+

delete an existing relationship

@@ -108117,26 +117484,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 + vip-ipv6-address -

Unique ID of the interface

+

IP address

 path @@ -108147,22 +117498,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

- 		query - string - - - -
@@ -108194,17 +117529,81 @@ 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

+
returns vnfcs
+

GET /network/vnfcs

+ Tags: + Network +
+
+
+

returns vnfcs

+ +
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vnfcs +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns vnfc
+

GET /network/vnfcs/vnfc/{vnfc-name}

Tags: Network
-

returns cvlan-tags

+

returns vnfc

@@ -108221,10 +117620,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 @@ -108237,26 +117636,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + nfc-naming-code -

Unique ID of the interface

+

Short code that is used in naming instances of the item being modeled

pathquery 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 @@ -108268,10 +117666,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 @@ -108283,10 +117681,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 @@ -108298,14 +117696,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 @@ -108313,14 +117710,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 @@ -108328,10 +117724,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 @@ -108343,10 +117739,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 @@ -108358,10 +117754,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 @@ -108371,42 +117767,201 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vnfc +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vnfc
+

PUT /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

create or update an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+

vnfc object that needs to be created or updated

+

+
+
+
+
+ /vnfc +
+
+
+
+
+ + + + + + + + + + + - + + +
- port-group-id + vnfc-name -

Unique ID for port group in vmware

+

Unique ID of vnfc.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing vnfc
+

DELETE /network/vnfcs/vnfc/{vnfc-name}

+ Tags: + Network +
+
+
+

delete an existing vnfc

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + @@ -108425,29 +117981,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /cvlan-tags -
-
-
- -
default @@ -108470,17 +118003,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-ipv4-address-list
+

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

returns cvlan-tag-entry

+

returns l3-interface-ipv4-address-list

@@ -108497,10 +118030,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 + resource-version -

Heat stack id corresponding to this instance, managed by MSO

+

resource-version for concurrency

 query @@ -108414,6 +117969,7 @@ 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 @@ -108513,10 +118046,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 @@ -108529,26 +118062,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 @@ -108560,10 +118092,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 @@ -108575,10 +118107,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 @@ -108590,14 +118122,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 @@ -108605,14 +118136,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 @@ -108620,10 +118150,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 @@ -108635,10 +118165,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 @@ -108650,10 +118180,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 @@ -108665,14 +118195,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 @@ -108680,10 +118210,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 @@ -108695,10 +118225,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 @@ -108734,7 +118264,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- /cvlan-tag-entry + /l3-interface-ipv4-address-list
@@ -108762,17 +118292,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-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 cvlan-tag-entry

+

create or update an existing l3-interface-ipv4-address-list

@@ -108781,13 +118311,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-ipv4-address-list object that needs to be created or updated

- /cvlan-tag-entry + /l3-interface-ipv4-address-list
@@ -108806,10 +118336,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 @@ -108822,10 +118352,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 @@ -108836,22 +118366,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 - - - -
@@ -108883,17 +118397,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
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}

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: Network
-

delete an existing cvlan-tag-entry

+

delete an existing l3-interface-ipv4-address-list

@@ -108915,10 +118429,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 @@ -108931,10 +118445,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 @@ -108945,22 +118459,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 - - - - - - resource-version @@ -109008,11 +118506,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}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -109052,10 +118550,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 @@ -109068,10 +118566,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 @@ -109082,22 +118580,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 - - - - - - @@ -109129,11 +118611,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}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

+

DELETE /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Tags: Network
@@ -109161,10 +118643,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 @@ -109177,10 +118659,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 @@ -109191,22 +118673,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 - - - - - - @@ -109238,36 +118704,19 @@ 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

+
returns l3-interface-ipv6-address-list
+

GET /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: Network
-

see node definition for valid relationships

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated

-

-
-
-
-
- /relationship -
-
-
-
@@ -109282,10 +118731,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 @@ -109298,10 +118747,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 @@ -109312,97 +118761,182 @@ 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/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -109414,6 +118948,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 @@ -109436,17 +118993,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}/relationship-list/relationship

+
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
-

see node definition for valid relationships

+

create or update an existing l3-interface-ipv6-address-list

@@ -109455,13 +119012,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
@@ -109480,10 +119037,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
- vnf-id + nfc-naming-code -

Unique id of VNF. This is unique across the graph.

+

Short code that is used in naming instances of the item being modeled

pathquery string -
- interface-id + nfc-function -

Unique ID of the interface

+

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

pathquery + string + + +
+ prov-status + +

prov status of this vnfc

+ 		query + string + + +
+ ipaddress-v4-oam-vip + +

Oam V4 vip address of this vnfc

+ 		query + string + + +
+ in-maint + + query + boolean + + +
+ is-closed-loop-disabled + + query + boolean + + +
+ group-notation + +

Group notation of VNFC

+ 		query + string + + +
+ model-invariant-id + +

the ASDC model id for this resource or service model.

+ 		query + string + + +
+ model-version-id + +

the ASDC model version for this resource or service model.

+ 		query + string + + +
+ vlan-id-inner + +

Inner VLAN tag

+ 		query + integer + + +
+ neutron-network-id + +

Neutron network id of the interface that address belongs to

+ 		query + string + + +
+ neutron-subnet-id + +

Neutron id of subnet that address belongs to

+ 		query string -
- vnf-id + vnfc-name -

Unique id of VNF. This is unique across the graph.

+

Unique ID of vnfc.

 path @@ -109494,73 +119051,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/vces/vce/{vnf-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - +
- vnf-id + l3-interface-ipv6-address -

Unique id of VNF. This is unique across the graph.

+

IP address

 path @@ -109602,83 +119098,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
-
-
returns vnfcs
-

GET /network/vnfcs

- Tags: - Network -
-
-
-

returns vnfcs

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vnfcs -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
+ +
-
returns vnfc
-

GET /network/vnfcs/vnfc/{vnfc-name}

+
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
-

returns vnfc

+

delete an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -109709,128 +119146,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -109849,29 +119185,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vnfc -
-
-
- -
default @@ -109894,17 +119207,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}

+
see node definition for valid relationships
+

PUT /network/vnfcs/vnfc/{vnfc-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: Network
-

create or update an existing vnfc

+

see node definition for valid relationships

@@ -109913,13 +119226,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

+

relationship object that needs to be created or updated

- /vnfc + /relationship
@@ -109952,6 +119265,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- nfc-naming-code - -

Short code that is used in naming instances of the item being modeled

- 		query - string - - -
- nfc-function - -

English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service

- 		query - string - - -
- prov-status - -

prov status of this vnfc

- 		query - string - - -
- ipaddress-v4-oam-vip - -

Oam V4 vip address of this vnfc

- 		query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- group-notation - -

Group notation of VNFC

- 		query - string - - -
- model-invariant-id + l3-interface-ipv6-address -

the ASDC model id for this resource or service model.

+

IP address

querypath string +
- model-version-id + resource-version -

the ASDC model version for this resource or service model.

+

resource-version for concurrency

 query @@ -109838,6 +119173,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ l3-interface-ipv6-address + +

IP address

+ 		path + string + + + +
@@ -109983,17 +119312,17 @@ 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}

+
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 vnfc

+

delete an existing relationship

@@ -110031,12 +119360,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 @@ -136734,8 +146063,6 @@ 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

-
Default Delete Scope
-

CASCADE_TO_CHILDREN

  • TO generic-vnf (Many2Many)
    • @@ -136973,183 +146300,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
-
-

auth-info-item: - object - - - -

-
-
-
-

Persistent auth info.

- -
    -
  • TO tenant (One2One)
    • -
  • FROM cloud-region (is composed of auth-info-item)
- -
- -
-
-
- auth-info-item-id: - string - - - -
-
-

Unique ID of auth-info-item.

-
- -
-
-
- cloud-domain: - string - - - -
-
-

domain info for authentication.

-
- -
-
-
- username: - string - - - -
-
-

user name of auth infomation to access VIM.

-
- -
-
-
- password: - string - - - -
-
-

password of auth infomation to access VIM.

-
- -
-
-
- auth-url: - string - - - -
-
-

authentication url of the cloud.

-
- -
-
-
- ssl-cacert: - string - - - -
-
-

ca file content if enabled ssl on auth-url.

-
- -
-
-
- ssl-insecure: - boolean - - - -
-
-

Whether to verify VIM's certificate.

-
- -
-
-
- relationship-list: - object[] - - -
-
- -
- -
- relationship - - - -
- -
-
-
-
-
-
-
-
-
-

auth-info-items: - object - - - -

-
-
-
-

Collection of persistent auth information to access to VIM.

- -
- -
-
-
- auth-info-item: - object[] - - -
-
- -
- -
- auth-info-item - - - -
- -
-
-
-
-
-
-

availability-zone: @@ -137162,8 +146312,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

Availability zone, a collection of compute hosts/pservers

-
Default Delete Scope
-

ERROR_IF_ANY_IN_EDGES

  • TO complex (Many2Many)
    • @@ -137405,6 +146553,86 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
    +
    +
+ +
+ lines-of-business: + object[] + + +
+
+ +
+ +
+ line-of-business + + + +
+ +
+
+
+
+ owning-entities: + object[] + + +
+
+ +
+ +
+ owning-entity + + + +
+ +
+
+
+
+ platforms: + object[] + + +
+
+ +
+ +
+ platform + + + +
+ +
+
+
+
+ projects: + object[] + + +
+
+ +
+ +
+ project + + + +
+
@@ -137423,9 +146651,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
Default Delete Scope
-

THIS_NODE_ONLY

- +
  • FROM site-pair (is composed of class-of-service)
@@ -137680,14 +146906,12 @@ 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.

-
Default Delete Scope
-

THIS_NODE_ONLY

    +
  • TO esr-system-info (comprises cloud-region, One2Many)
  • TO complex (Many2One)
  • TO l3-network (Many2Many)
  • TO tenant (comprises cloud-region, One2Many)
    • -
  • TO auth-info-item (comprises cloud-region, One2Many)
  • TO image (comprises cloud-region, One2Many)
  • TO flavor (comprises cloud-region, One2Many)
  • TO availability-zone (comprises cloud-region, One2Many)
    • @@ -137814,6 +147038,30 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ cloud-extra-info: + string + + +
+
+

ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.

+
+ +
+
+
+ cloud-epa-caps: + string + + +
+
+

MultiVIM will discover and expose EPA capabilities.

+
+ +
+
resource-version: string @@ -138026,8 +147274,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
- auth-info-items: +
+ esr-system-info-list: object[] @@ -138037,7 +147285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- auth-info-item + esr-system-info @@ -138099,8 +147347,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

Collection of physical locations that can house cloud-regions.

-
Default Delete Scope
-

ERROR_4_IN_EDGES_OR_CASCADE

  • TO ctag-pool (comprises complex, Many2Many)
    • @@ -138417,8 +147663,6 @@ 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

    -
    Default Delete Scope
    -

    CASCADE_TO_CHILDREN

    • TO virtual-data-center (Many2Many)
      • @@ -138611,8 +147855,6 @@ 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.

      -
      Default Delete Scope
      -

      CASCADE_TO_CHILDREN

      • TO element-choice-set (comprises constrained-element-set, One2Many)
        • @@ -138762,9 +148004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
      -
      Default Delete Scope
      -

      THIS_NODE_ONLY

      - +
      • FROM l3-network (is composed of ctag-assignment)
      • FROM service-instance
      @@ -138871,8 +148111,6 @@ 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.

      -
      Default Delete Scope
      -

      THIS_NODE_ONLY

      • TO availability-zone (Many2Many)
        • @@ -139020,8 +148258,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

        customer identifiers to provide linkage back to BSS information.

        -
        Default Delete Scope
        -

        CASCADE_TO_CHILDREN

        • TO service-subscription (comprises customer, Many2Many)
        @@ -139277,8 +148513,6 @@ 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.

        -
        Default Delete Scope
        -

        THIS_NODE_ONLY

        • TO availability-zone (Many2Many)
          • @@ -139648,8 +148882,6 @@ 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.

          -
          Default Delete Scope
          -

          CASCADE_TO_CHILDREN

          • TO model-element (comprises element-choice-set, One2Many)
            • @@ -139798,8 +149030,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

            Metadata for entitlement group.

            -
            Default Delete Scope
            -

            THIS_NODE_ONLY

            • FROM generic-vnf (is composed of entitlement)
              • @@ -139912,6 +149142,846 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
          +
          +
          +

          esr-ems: + object + + + +

          +
          +
          +
          +

          Persist EMS address information used by EMS driver.

          + +
            +
          • TO esr-system-info (comprises esr-ems, One2Many)
          + +
          + +
          +
          +
          + ems-id: + string + + + +
          +
          +

          Unique ID of EMS.

          +
          + +
          +
          +
          + resource-version: + string + + +
          +
          +

          Used for optimistic concurrency. Must be empty on create, valid on update and delete.

          +
          + +
          +
          +
          + esr-system-info-list: + object[] + + +
          +
          + +
          + +
          + esr-system-info + + + +
          + +
          +
          +
          +
          + relationship-list: + object[] + + +
          +
          + +
          + +
          + relationship + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-ems-list: + object + + + +

          +
          +
          + +
          +
          +
          + esr-ems: + object[] + + +
          +
          + +
          + +
          + esr-ems + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-system-info: + object + + + +

          +
          +
          +
          +

          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)
          + +
          + +
          +
          +
          + esr-system-info-id: + string + + + +
          +
          +

          Unique ID of esr system info.

          +
          + +
          +
          +
          + system-name: + string + + +
          +
          +

          name of external system.

          +
          + +
          +
          +
          + type: + string + + +
          +
          +

          type of external systems.

          +
          + +
          +
          +
          + vendor: + string + + +
          +
          +

          vendor of external systems.

          +
          + +
          +
          +
          + version: + string + + +
          +
          +

          version of external systems.

          +
          + +
          +
          +
          + service-url: + string + + +
          +
          +

          url used to access external systems.

          +
          + +
          +
          +
          + user-name: + string + + + +
          +
          +

          username used to access external systems.

          +
          + +
          +
          +
          + password: + string + + + +
          +
          +

          password used to access external systems.

          +
          + +
          +
          +
          + system-type: + string + + + +
          +
          +

          it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

          +
          + +
          +
          +
          + protocol: + string + + +
          +
          +

          protocol of third party SDNC, for example netconf/snmp.

          +
          + +
          +
          +
          + ssl-cacert: + string + + +
          +
          +

          ca file content if enabled ssl on auth-url.

          +
          + +
          +
          +
          + ssl-insecure: + boolean + + +
          +
          +

          Whether to verify VIM's certificate.

          +
          + +
          +
          +
          + ip-address: + string + + +
          +
          +

          service IP of ftp server.

          +
          + +
          +
          +
          + port: + string + + +
          +
          +

          service port of ftp server.

          +
          + +
          +
          +
          + cloud-domain: + string + + +
          +
          +

          domain info for authentication.

          +
          + +
          +
          +
          + default-tenant: + string + + +
          +
          +

          default tenant of VIM.

          +
          + +
          +
          +
          + passive: + boolean + + +
          +
          +

          ftp passive mode or not.

          +
          + +
          +
          +
          + remote-path: + string + + +
          +
          +

          resource or performance data file path.

          +
          + +
          +
          +
          + system-status: + string + + +
          +
          +

          the status of external system.

          +
          + +
          +
          +
          + resource-version: + string + + +
          +
          +

          Used for optimistic concurrency. Must be empty on create, valid on update and delete.

          +
          + +
          +
          +
          + relationship-list: + object[] + + +
          +
          + +
          + +
          + relationship + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-system-info-list: + object + + + +

          +
          +
          +
          +

          Collection of persistent block-level external system auth info.

          + +
          + +
          +
          +
          + esr-system-info: + object[] + + +
          +
          + +
          + +
          + esr-system-info + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-thirdparty-sdnc: + object + + + +

          +
          +
          +
          +

          Persist SDNC address information used by ONAP SDNC.

          + +
            +
          • TO esr-system-info (comprises esr-thirdparty-sdnc, One2One)
            • +
          • TO pnf (One2Many)
          + +
          + +
          +
          +
          + thirdparty-sdnc-id: + string + + + +
          +
          +

          Unique ID of SDNC.

          +
          + +
          +
          +
          + location: + string + + +
          +
          +

          used for DC type to indicate the location of SDNC, such as Core or Edge.

          +
          + +
          +
          +
          + product-name: + string + + +
          +
          +

          password used to access SDNC server.

          +
          + +
          +
          +
          + resource-version: + string + + +
          +
          +

          Used for optimistic concurrency. Must be empty on create, valid on update and delete.

          +
          + +
          +
          +
          + esr-system-info-list: + object[] + + +
          +
          + +
          + +
          + esr-system-info + + + +
          + +
          +
          +
          +
          + relationship-list: + object[] + + +
          +
          + +
          + +
          + relationship + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-thirdparty-sdnc-list: + object + + + +

          +
          +
          + +
          +
          +
          + esr-thirdparty-sdnc: + object[] + + +
          +
          + +
          + +
          + esr-thirdparty-sdnc + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-vnfm: + object + + + +

          +
          +
          +
          +

          Persist VNFM address information used by VF-C.

          + +
            +
          • TO esr-system-info (comprises esr-vnfm, One2One)
          + +
          + +
          +
          +
          + vnfm-id: + string + + + +
          +
          +

          Unique ID of VNFM.

          +
          + +
          +
          +
          + vim-id: + string + + +
          +
          +

          indecate the VIM to deploy VNF.

          +
          + +
          +
          +
          + certificate-url: + string + + +
          +
          +

          certificate url of VNFM.

          +
          + +
          +
          +
          + resource-version: + string + + +
          +
          +

          Used for optimistic concurrency. Must be empty on create, valid on update and delete.

          +
          + +
          +
          +
          + esr-system-info-list: + object[] + + +
          +
          + +
          + +
          + esr-system-info + + + +
          + +
          +
          +
          +
          + relationship-list: + object[] + + +
          +
          + +
          + +
          + relationship + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          esr-vnfm-list: + object + + + +

          +
          +
          + +
          +
          +
          + esr-vnfm: + object[] + + +
          +
          + +
          + +
          + esr-vnfm + + + +
          + +
          +
          +
          +
          +
          +
          +
          +
          +
          +

          external-system: + object + + + +

          +
          +
          +
          +

          Namespace for external system.

          + +
          + +
          +
          +
          + esr-ems-list: + object[] + + +
          +
          + +
          + +
          + esr-ems + + + +
          + +
          +
          +
          +
          + esr-vnfm-list: + object[] + + +
          +
          + +
          + +
          + esr-vnfm + + + +
          + +
          +
          +
          +
          + esr-thirdparty-sdnc-list: + object[] + + +
          +
          + +
          + +
          + esr-thirdparty-sdnc + + + +
          + +
          +
          +
          +
          +
          +
          +

          extra-properties: @@ -140004,8 +150074,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

          Openstack flavor.

          -
          Default Delete Scope
          -

          ERROR_IF_ANY_IN_EDGES

          • FROM cloud-region (is composed of flavor)
            • @@ -140227,8 +150295,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

            General purpose VNF

            -
            Default Delete Scope
            -

            CASCADE_TO_CHILDREN

            • TO license-key-resource (Many2Many)
              • @@ -140252,6 +150318,8 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
            • 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
            @@ -141040,8 +151108,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

            Openstack group-assignment used to store exclusivity groups (EG).

            -
            Default Delete Scope
            -

            THIS_NODE_ONLY

            • TO tenant (Many2Many)
              • @@ -141180,6 +151246,149 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
            +
            +
            +

            host-route: + object + + + +

            +
            +
            +
            + +
              +
            • FROM subnet (is composed of host-route)
            + +
            + +
            +
            +
            + host-route-id: + string + + + +
            +
            +

            host-route id

            +
            + +
            +
            +
            + route-prefix: + string + + + +
            +
            +

            subnet prefix

            +
            + +
            +
            +
            + next-hop: + string + + + +
            +
            +

            Could be ip-address, hostname, or service-instance

            +
            + +
            +
            +
            + next-hop-type: + string + + +
            +
            +

            Should be ip-address, hostname, or service-instance to match next-hop

            +
            + +
            +
            +
            + resource-version: + string + + +
            +
            +

            Used for optimistic concurrency. Must be empty on create, valid on update and delete.

            +
            + +
            +
            +
            + relationship-list: + object[] + + +
            +
            + +
            + +
            + relationship + + + +
            + +
            +
            +
            +
            +
            +
            +
            +
            +
            +

            host-routes: + object + + + +

            +
            +
            + +
            +
            +
            + host-route: + object[] + + +
            +
            + +
            + +
            + host-route + + + +
            + +
            +
            +
            +
            +
            +
            +

            image: @@ -141192,8 +151401,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

            Openstack image.

            -
            Default Delete Scope
            -

            ERROR_4_IN_EDGES_OR_CASCADE

            • TO metadatum (comprises image, Many2Many)
              • @@ -141516,8 +151723,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

              General mechanism for grouping instances

              -
              Default Delete Scope
              -

              THIS_NODE_ONLY

              • TO model (Many2Many)
                • @@ -141775,6 +151980,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
            +
            + external-system: + object + + +
            +
            + +
            + +
            + external-system + + + +
            + +
            +
            +
            business: object @@ -142122,8 +152347,6 @@ 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

            -
            Default Delete Scope
            -

            CASCADE_TO_CHILDREN

            • TO vig-server (comprises ipsec-configuration, One2Many)
              • @@ -142530,8 +152753,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

              Logical interfaces, e.g., a vnic.

              -
              Default Delete Scope
              -

              CASCADE_TO_CHILDREN

              • TO instance-group (Many2Many)
                • @@ -142722,6 +152943,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
              +
              + allowed-address-pairs: + string + + +
              +
              +

              Freeform field for storing an ip address, list of ip addresses or a subnet block.

              +
              + +
              +
              vlans: object[] @@ -142899,13 +153132,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

              IPv4 Address Range

              -
              Default Delete Scope
              -

              THIS_NODE_ONLY

              • 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)
              @@ -143046,13 +153278,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

              IPv6 Address Range

              -
              Default Delete Scope
              -

              THIS_NODE_ONLY

              • 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)
              @@ -143193,8 +153424,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

              Generic network definition

              -
              Default Delete Scope
              -

              CASCADE_TO_CHILDREN

              • TO vpn-binding (Many2Many)
                • @@ -143665,8 +153894,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

                Link aggregate interface

                -
                Default Delete Scope
                -

                CASCADE_TO_CHILDREN

                • TO logical-link (Many2Many)
                  • @@ -143888,8 +154115,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

                  LAG links can connect lag-interfaces

                  -
                  Default Delete Scope
                  -

                  THIS_NODE_ONLY

                  • FROM lag-interface
                    • @@ -144001,8 +154226,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

                    Metadata for license group.

                    -
                    Default Delete Scope
                    -

                    THIS_NODE_ONLY

                    • FROM generic-vnf (is composed of license)
                      • @@ -144115,6 +154338,116 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
                  +
                  +
                  +

                  line-of-business: + object + + + +

                  +
                  +
                  +
                  +

                  describes a line-of-business

                  + +
                    +
                  • TO generic-vnf (Many2Many)
                  + +
                  + +
                  +
                  +
                  + line-of-business-name: + string + + + +
                  +
                  +

                  Name of the line-of-business (product)

                  +
                  + +
                  +
                  +
                  + resource-version: + string + + +
                  +
                  +

                  Used for optimistic concurrency. Must be empty on create, valid on update and delete.

                  +
                  + +
                  +
                  +
                  + relationship-list: + object[] + + +
                  +
                  + +
                  + +
                  + relationship + + + +
                  + +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +
                  +

                  lines-of-business: + object + + + +

                  +
                  +
                  +
                  +

                  Collection of lines-of-business

                  + +
                  + +
                  +
                  +
                  + line-of-business: + object[] + + +
                  +
                  + +
                  + +
                  + line-of-business + + + +
                  + +
                  +
                  +
                  +
                  +
                  +
                  +