X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=aai-schema%2Fsrc%2Fmain%2Fresources%2Faai_swagger_html%2Faai_swagger_v12.html;h=0e3890d1a64bec2355be8493229470e72f3d5e1b;hb=f1a8fb1bc04f5d685f2b31d35db605f6fa054f60;hp=77ee6f428f961786fb895950cadbe7bcf41564ee;hpb=b1264ad4012f67664d71982a0eaad7e9bcce34f4;p=aai%2Faai-common.git diff --git a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html index 77ee6f42..0e3890d1 100644 --- a/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html +++ b/aai-schema/src/main/resources/aai_swagger_html/aai_swagger_v12.html @@ -5869,70 +5869,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns connectors

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns connector
-

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

- Tags: - Business -
-
-
-

returns connector

-
@@ -5951,15 +5887,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen resource-instance-id - + @@ -5967,7 +5901,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Unique id of resource instance.

pathquery string -
-

the ASDC model id for this resource or service model.

query @@ -5982,7 +5915,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

the ASDC model version for this resource or service model.

query @@ -5997,7 +5929,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -6012,7 +5943,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -6048,7 +5978,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -6061,7 +5991,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6077,35 +6007,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing connector
-

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

+
returns connector
+

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

Tags: Business
-

create or update an existing connector

+

returns connector

-
- -

application/json application/xml -

-
-
-

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

-

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

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6166,16 +6102,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
update an existing connector
-

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

+
create or update an existing connector
+

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

Tags: Business
-

update an existing connector

+

create or update an existing connector

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

-

connector object that needs to be created or updated.

+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

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

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

+
update an existing connector
+

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

Tags: Business
-

delete an existing connector

+

update an existing connector

application/json application/xml

+
+
+

connector object that needs to be updated.

+

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6347,19 +6279,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns metadata
-

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

+
delete an existing connector
+

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

Tags: Business
-

returns metadata

+

delete an existing connector

+
+ +

application/json application/xml +

+
@@ -6390,55 +6327,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - @@ -6457,29 +6350,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /metadata -
-
-
- -
default @@ -6487,7 +6357,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -6502,17 +6372,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns metadatum
-

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

+
returns metadata
+

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

Tags: Business
-

returns metadatum

+

returns metadata

@@ -6548,37 +6418,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen metaname
- - - - - - - - - - - - - - + +
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version + resource-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

resource-version for concurrency

query @@ -6446,6 +6338,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- path - string - - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

query @@ -6588,34 +6427,114 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ +
+ /metadata +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns metadatum
+

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

+ Tags: + Business +
+
+
+

returns metadatum

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7166,70 +7085,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns customers

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns customer
-

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

- Tags: - Business -
-
-
-

returns customer

-
- widget-model-id + resource-instance-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique id of resource instance.

querypath string +
- widget-model-version + metaname -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

querypath string +
@@ -7248,15 +7103,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen global-customer-id - + @@ -7264,7 +7117,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen subscriber-name - - - - - - - - - - - - - - - - - - - - -
-

Global customer id used across ECOMP to uniquely identify customer.

pathquery string -
-

Subscriber name, an alternate way to retrieve a customer.

query @@ -7279,7 +7131,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen subscriber-type -

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

query @@ -7315,7 +7166,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -7328,7 +7179,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7344,35 +7195,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing customer
-

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

+
returns customer
+

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

Tags: Business
-

create or update an existing customer

+

returns customer

-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
- /customer -
-
-
-
@@ -7410,6 +7244,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /customer +
+
+
+ +
default @@ -7417,7 +7274,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7433,16 +7290,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
update an existing customer
-

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

+
create or update an existing customer
+

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

Tags: Business
-

update an existing customer

+

create or update an existing customer

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

-

customer object that needs to be created or updated.

+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7522,16 +7379,105 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing customer
-

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

+
update an existing customer
+

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

Tags: Business
-

delete an existing customer

+

update an existing customer

+ +
+
+ +

application/json application/xml +

+
+
+

customer object that needs to be updated.

+

+
+
+
+
+ /customer +
+
+
+
+
+
+ + + + + + + + + + + + + + + + + + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

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

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing customer
+

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

+ Tags: + Business +
+
+
+

delete an existing customer

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7823,25 +7769,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type + service-type -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -7962,36 +7892,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

service-subscription object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -8575,147 +8475,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns service-instances

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- global-customer-id - -

Global customer id used across ECOMP to uniquely identify customer.

-
path - string - - - -
- service-type - -

Value defined by orchestration to identify this service across ECOMP.

-
path - string - - - -
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
- - - - -
-
-
returns service-instance
-

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

- Tags: - Business -
-
-
-

returns service-instance

-
@@ -8766,23 +8525,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-instance-id - + + +
-

Uniquely identifies this instance of a service

pathquery string -
- subscriber-name + service-instance-name -

Subscriber name, an alternate way to retrieve a customer.

query @@ -8794,10 +8550,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-type + environment-context -

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

query @@ -8809,10 +8564,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- service-instance-name + workload-context -

This field will store a name assigned to the service-instance.

query @@ -8824,10 +8578,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- environment-context + model-invariant-id -

This field will store the environment context assigned to the service-instance.

query @@ -8839,10 +8592,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- workload-context + model-version-id -

This field will store the workload context assigned to the service-instance.

query @@ -8854,10 +8606,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + widget-model-id -

the ASDC model id for this resource or service model.

query @@ -8869,10 +8620,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + widget-model-version -

the ASDC model version for this resource or service model.

query @@ -8884,10 +8634,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-id + service-instance-location-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -8899,10 +8648,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + orchestration-status -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -8912,34 +8660,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns service-instance
+

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

+ Tags: + Business +
+
+
+

returns service-instance

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

service-instance object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -9438,40 +9283,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - + +
+ global-customer-id + +

Global customer id used across ECOMP to uniquely identify customer.

+
path + string + + + +
- service-instance-location-id + service-type -

An identifier that customers assign to the location where this service is being used.

+

Value defined by orchestration to identify this service across ECOMP.

querypath string +
- orchestration-status + service-instance-id -

Orchestration status of this service.

+

Uniquely identifies this instance of a service

querypath string +
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
- service-instance-name + id -

This field will store a name assigned to the service-instance.

query @@ -9483,10 +9297,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- environment-context + model-invariant-id -

This field will store the environment context assigned to the service-instance.

query @@ -9498,10 +9311,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- workload-context + model-version-id -

This field will store the workload context assigned to the service-instance.

query @@ -9513,10 +9325,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-invariant-id + type -

the ASDC model id for this resource or service model.

query @@ -9528,10 +9339,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- model-version-id + role -

the ASDC model version for this resource or service model.

query @@ -9541,432 +9351,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+ +
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns allotted-resource
+

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

+ Tags: + Business +
+
+
+

returns allotted-resource

+ +
+
+ + + + + + + + + + + - + - + - + - - - - - -
- widget-model-id + global-customer-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Global customer id used across ECOMP to uniquely identify customer.

querypath string +
- widget-model-version + service-type -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Value defined by orchestration to identify this service across ECOMP.

querypath string +
- service-instance-location-id + service-instance-id -

An identifier that customers assign to the location where this service is being used.

+

Uniquely identifies this instance of a service

querypath string +
- orchestration-status + id -

Orchestration status of this service.

+

Allotted Resource id UUID assigned to this instance.

query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns allotted-resource
-

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

- Tags: - Business -
-
-
-

returns allotted-resource

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

allotted-resource object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -10791,220 +10316,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- global-customer-id - -

Global customer id used across ECOMP to uniquely identify customer.

-
path - string - - - -
- service-type - -

Value defined by orchestration to identify this service across ECOMP.

-
path - string - - - -
- service-instance-id - -

Uniquely identifies this instance of a service

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

Allotted Resource id UUID assigned to this instance.

-
path - string - - - -
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- environment-context - -

This field will store the environment context assigned to the service-instance.

-
query - string - - -
- workload-context - -

This field will store the workload context assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- type - -

Generic description of the type of allotted resource.

-
query - string - - -
- role - -

role in the network that this resource will be providing.

-
querypath string +
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- environment-context - -

This field will store the environment context assigned to the service-instance.

-
query - string - - -
- workload-context - -

This field will store the workload context assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- type - -

Generic description of the type of allotted resource.

-
query - string - - -
- role + id -

role in the network that this resource will be providing.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -11173,231 +10487,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- environment-context - -

This field will store the environment context assigned to the service-instance.

-
query - string - - -
- workload-context - -

This field will store the workload context assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- type - -

Generic description of the type of allotted resource.

-
query - string - - -
- role - -

role in the network that this resource will be providing.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

tunnel-xconnect object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12284,160 +11373,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- environment-context - -

This field will store the environment context assigned to the service-instance.

-
query - string - - -
- workload-context - -

This field will store the workload context assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status + metaname -

Orchestration status of this service.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -12589,171 +11527,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- subscriber-name - -

Subscriber name, an alternate way to retrieve a customer.

-
query - string - - -
- subscriber-type - -

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

-
query - string - - -
- service-instance-name - -

This field will store a name assigned to the service-instance.

-
query - string - - -
- environment-context - -

This field will store the environment context assigned to the service-instance.

-
query - string - - -
- workload-context - -

This field will store the workload context assigned to the service-instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- service-instance-location-id - -

An identifier that customers assign to the location where this service is being used.

-
query - string - - -
- orchestration-status - -

Orchestration status of this service.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -13463,6 +12236,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns lines-of-business

+
+ + + + + + + + + + + + + + + + + + + +
+ line-of-business-name + + query + string + + +
+

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

-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14059,6 +12861,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns owning-entities

+
+ + + + + + + + + + + + + + + + + + + +
+ owning-entity-id + + query + string + + +
+

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

-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

owning-entity object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -14655,6 +13486,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns platforms

+
+ + + + + + + + + + + + + + + + + + + +
+ platform-name + + query + string + + +
+

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

-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

platform object that needs to be created or updated.

+

platform object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15251,6 +14111,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns projects

+
+ + + + + + + + + + + + + + + + + + + +
+ project-name + + query + string + + +
+

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

-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

project object that needs to be created or updated.

+

project object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15847,6 +14736,77 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns cloud-regions

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

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

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -15955,36 +14915,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 - - - - -
@@ -16024,7 +14954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

cloud-region object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16417,25 +15347,9 @@ 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 + availability-zone-name -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -16572,36 +15486,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 - - - - - @@ -16641,7 +15525,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

availability-zone object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17312,10 +16196,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + switch-name -

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

query @@ -17327,10 +16210,9 @@ 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)

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -17467,51 +16349,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 - - - - - @@ -17551,7 +16388,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

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

+

dvs-switch object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18222,10 +17059,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + flavor-id -

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

query @@ -18237,10 +17073,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + flavor-name -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18377,51 +17212,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 - - - - - - - - flavor-name - - -

Cloud region Flavor name

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

flavor object that needs to be created or updated.

+

flavor object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -18918,10 +17708,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + hpa-capability-id -

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

query @@ -18933,10 +17722,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + hpa-feature -

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

query @@ -18948,10 +17736,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - flavor-name + architecture -

Cloud region Flavor name

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19104,79 +17891,164 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing hpa-capability
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing hpa-capability

+ +
+
+ +

application/json application/xml +

+
+
+

hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)

+

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19234,16 +18083,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing hpa-capability
-

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

+
update an existing hpa-capability
+

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

Tags: CloudInfrastructure
-

create or update an existing hpa-capability

+

update an existing hpa-capability

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

-

hpa-capability object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapability.json)

+

hpa-capability object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19371,34 +18220,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing hpa-capability
-

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

+
delete an existing hpa-capability
+

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

Tags: CloudInfrastructure
-

update an existing hpa-capability

+

delete an existing hpa-capability

application/json application/xml

-
-
-

hpa-capability object that needs to be created or updated.

-

-
-
-
- -
-
- 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 +
- flavor-name + cloud-region-id -

Cloud region Flavor name

+

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

querypath string +
- hpa-feature + flavor-id -

Name of the HPACapability

+

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

querypath string +
- architecture + hpa-capability-id -

Hardware architecture

+

UUID to uniquely identify a HPA capability

querypath string +
@@ -19476,6 +18313,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19507,24 +18360,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing hpa-capability
-

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

+
returns hpa-feature-attributes
+

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure
-

delete an existing hpa-capability

+

returns hpa-feature-attributes

-
- -

application/json application/xml -

-
@@ -19603,12 +18451,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - -
- resource-version + hpa-attribute-key -

resource-version for concurrency

+

name of the specific HPA attribute

querypath string @@ -19626,6 +18474,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19649,18 +18520,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns hpa-feature-attributes
-

GET /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

+
create or update an existing hpa-feature-attributes
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure
-

returns hpa-feature-attributes

+

create or update an existing hpa-feature-attributes

+
+ +

application/json application/xml +

+
+
+

hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)

+

+
+ +
+
@@ -19753,79 +18641,157 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing hpa-feature-attributes
+

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing hpa-feature-attributes

+ +
+
+ +

application/json application/xml +

+
+
+

hpa-feature-attributes object that needs to be updated.

+

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -19883,34 +18826,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing hpa-feature-attributes
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

+
delete an existing hpa-feature-attributes
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

Tags: CloudInfrastructure
-

create or update an existing hpa-feature-attributes

+

delete an existing hpa-feature-attributes

application/json application/xml

-
-
-

hpa-feature-attributes object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavorHpaCapabilitiesHpaCapabilityHpaFeatureAttributes.json)

-

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

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

+

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

querypath string +
- owner-defined-type + cloud-region-id -

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

+

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

querypath string +
- flavor-name + flavor-id -

Cloud region Flavor name

+

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

querypath string +
- hpa-feature + hpa-capability-id -

Name of the HPACapability

+

UUID to uniquely identify a HPA capability

querypath string +
- architecture + hpa-attribute-key -

Hardware architecture

+

name of the specific HPA attribute

querypath string +
@@ -20004,6 +18935,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20035,17 +18982,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing hpa-feature-attributes
-

PATCH /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing hpa-feature-attributes

+

see node definition for valid relationships

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

-

hpa-feature-attributes object that needs to be created or updated.

+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20188,17 +19135,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing hpa-feature-attributes
-

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}

+
delete an existing relationship
+

DELETE /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing hpa-feature-attributes

+

delete an existing relationship

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20345,11 +19276,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}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -20364,7 +19295,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -20451,22 +19382,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - hpa-attribute-key - - -

name of the specific HPA attribute

- - path - - string - - - - - - @@ -20483,7 +19398,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20498,11 +19413,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}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/hpa-feature-attributes/{hpa-attribute-key}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -20592,22 +19507,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - hpa-attribute-key - - -

name of the specific HPA attribute

- - path - - string - - - - - - @@ -20624,7 +19523,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20639,11 +19538,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}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -20658,7 +19557,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -20729,22 +19628,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - hpa-capability-id - - -

UUID to uniquely identify a HPA capability

- - path - - string - - - - - - @@ -20761,7 +19644,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20776,11 +19659,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}/flavors/flavor/{flavor-id}/hpa-capabilities/hpa-capability/{hpa-capability-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -20854,22 +19737,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - hpa-capability-id - - -

UUID to uniquely identify a HPA capability

- - path - - string - - - - - - @@ -20886,7 +19753,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -20901,36 +19768,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 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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionFlavorsFlavor.json)

-

-
-
-
- -
-
-
@@ -20977,18 +19827,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -21000,6 +19876,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21022,24 +19921,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 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 -

-
- flavor-id + group-id -

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

pathquery + string + + +
+ group-type + + query + string + + +
+ group-name + + query string -
@@ -21086,10 +19980,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- flavor-id + group-id -

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

+

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

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

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21131,19 +20048,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 group-assignment
+

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

Tags: CloudInfrastructure
-

returns group-assignments

+

create or update an existing group-assignment

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+
@@ -21190,32 +20124,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -21227,29 +20147,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21273,18 +20170,35 @@ 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}

+
update an existing group-assignment
+

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

Tags: CloudInfrastructure
-

returns group-assignment

+

update an existing group-assignment

+
+ +

application/json application/xml +

+
+
+

group-assignment object that needs to be updated.

+

+
+
+
+
+
- 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 +
@@ -21345,66 +20259,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 - - -
- 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 - - -
@@ -21414,29 +20268,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21460,34 +20291,22 @@ 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}

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

create or update an existing group-assignment

+

delete an existing group-assignment

application/json application/xml

-
-
-

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

-

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21580,17 +20415,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing group-assignment
-

PATCH /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}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing group-assignment

+

see node definition for valid relationships

@@ -21599,13 +20434,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionGroupAssignmentsGroupAssignment.json)

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21701,17 +20536,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}/group-assignments/group-assignment/{group-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing group-assignment

+

delete an existing relationship

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -21826,36 +20645,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 hpa-capabilities
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns hpa-capabilities

-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
- -
-
-
@@ -21902,223 +20704,23 @@ 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.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

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

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

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

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

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

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

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns hpa-capabilities
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns hpa-capabilities

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

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

-
path - string - - - -
- cloud-region-id + hpa-capability-id -

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

pathquery string -
- cloud-type + hpa-feature -

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

query @@ -22130,10 +20732,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + architecture -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22270,66 +20871,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 - - -
- hpa-feature - -

Name of the HPACapability

-
query - string - - -
- architecture - -

Hardware architecture

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

hpa-capability object that needs to be created or updated.

+

hpa-capability object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -22840,66 +21381,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 - - - - - - - - hpa-feature - - -

Name of the HPACapability

- - query - - string - - - - - - - - architecture - - -

Hardware architecture

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

hpa-feature-attributes object that needs to be created or updated.

+

hpa-feature-attributes object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -23920,10 +22401,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + image-id -

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

query @@ -23935,10 +22415,51 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - owner-defined-type + image-name + + + + query + + string + + + + + + + + application + + + + query + + string + + + + + + + + application-vendor + + + + query + + string + + + + + + + + application-version -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24075,96 +22596,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 - - - - - - - - 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 - - - - - @@ -24204,7 +22635,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

image object that needs to be created or updated.

+

image object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24661,85 +23092,9 @@ 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 + metaname -

The version of the application.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -24891,96 +23246,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 - - - - - - - - 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 - - - - - @@ -25020,7 +23285,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25736,10 +24001,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + network-uuid -

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

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

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

query @@ -25764,6 +24027,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + cvlan-tag + + + + query + + integer + + + + + @@ -25803,7 +24080,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -25891,64 +24168,148 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing oam-network
+

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing oam-network

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26006,16 +24344,16 @@ 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}

+
update an existing oam-network
+

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

Tags: CloudInfrastructure
-

create or update an existing oam-network

+

update an existing oam-network

@@ -26024,13 +24362,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionOamNetworksOamNetwork.json)

+

oam-network object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

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

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

update an existing oam-network

+

delete an existing oam-network

application/json application/xml

-
-
-

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

-

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

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

+

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

querypath string +
- owner-defined-type + cloud-region-id -

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

+

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

querypath string +
- network-name + network-uuid -

Name of the network.

+

UUID of the network. Unique across a cloud-region

querypath string -
- cvlan-tag - -

cvlan-id

-
query - integer - - +
@@ -26216,6 +24542,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26247,23 +24589,35 @@ 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}

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

delete an existing oam-network

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26373,34 +24711,22 @@ 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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

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

-

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26493,23 +24819,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}/oam-networks/oam-network/{network-uuid}/relationship-list/relationship

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

+
+
+
+ +
+
@@ -26555,22 +24893,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- network-uuid - -

UUID of the network. Unique across a cloud-region

-
path - string - - - -
@@ -26587,7 +24909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26603,34 +24925,22 @@ 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

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

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

-

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26707,24 +25017,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 snapshots
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns snapshots

-
- -

application/json application/xml -

-
@@ -26769,6 +25074,90 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ snapshot-id + + query + string + + +
+ snapshot-name + + query + string + + +
+ application + + query + string + + +
+ application-vendor + + query + string + + +
+ application-version + + query + string + + +
+ prev-snapshot-id + + query + string + + +
@@ -26778,6 +25167,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26800,17 +25212,17 @@ 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

+
returns snapshot
+

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

Tags: CloudInfrastructure
-

returns snapshots

+

returns snapshot

@@ -26859,32 +25271,18 @@ 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 + snapshot-id -

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

+

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

- query + path string + @@ -26913,7 +25311,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -26926,7 +25324,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -26942,18 +25340,35 @@ 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}

+
create or update an existing snapshot
+

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

Tags: CloudInfrastructure
-

returns snapshot

+

create or update an existing snapshot

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /snapshot +
+
+
+
@@ -27014,111 +25429,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 - - -
- snapshot-name - -

Snapshot name

-
query - string - - -
- application - -

The application that the image instantiates.

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

The vendor of the application.

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

The version of the application.

-
query - string - - -
- prev-snapshot-id - -

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

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /snapshot -
-
-
- -
default @@ -27158,7 +25445,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27174,16 +25461,16 @@ 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}

+
update an existing snapshot
+

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

Tags: CloudInfrastructure
-

create or update an existing snapshot

+

update an existing snapshot

@@ -27192,13 +25479,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionSnapshotsSnapshot.json)

+

snapshot object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27295,34 +25582,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing snapshot
-

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

+
delete an existing snapshot
+

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

Tags: CloudInfrastructure
-

update an existing snapshot

+

delete an existing snapshot

application/json application/xml

-
-
-

snapshot object that needs to be created or updated.

-

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27415,23 +25706,35 @@ 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}

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

delete an existing snapshot

+

see node definition for valid relationships

application/json application/xml

+
+
+

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

+

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27541,34 +25828,22 @@ 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

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

see node definition for valid relationships

+

delete an existing relationship

application/json application/xml

-
-
-

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

-

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27661,24 +25936,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 tenants
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns tenants

-
- -

application/json application/xml -

-
@@ -27725,18 +25995,44 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + @@ -27748,6 +26044,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /tenants +
+
+
+ +
default @@ -27755,7 +26074,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27770,17 +26089,17 @@ 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

+
returns tenant
+

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

Tags: CloudInfrastructure
-

returns tenants

+

returns tenant

@@ -27829,32 +26148,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - + @@ -27883,7 +26188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -27896,7 +26201,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -27912,18 +26217,35 @@ 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}

+
create or update an existing tenant
+

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

Tags: CloudInfrastructure
-

returns tenant

+

create or update an existing tenant

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /tenant +
+
+
+
- snapshot-id + tenant-id -

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

pathquery + string + + +
+ tenant-name + + query + string + + +
+ tenant-context + + query string -
- cloud-type - -

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

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

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

+

Unique id relative to the cloud-region.

querypath string +
@@ -27984,66 +26306,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-type - -

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

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

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

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

Readable name of tenant

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

This field will store the tenant context.

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /tenant -
-
-
- -
default @@ -28083,7 +26322,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28099,16 +26338,16 @@ 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}

+
update an existing tenant
+

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

Tags: CloudInfrastructure
-

create or update an existing tenant

+

update an existing tenant

@@ -28117,13 +26356,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenant.json)

+

tenant object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28220,137 +26459,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing tenant
-

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

+
delete an existing tenant
+

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

Tags: CloudInfrastructure
-

update an existing tenant

- -
-
- -

application/json application/xml -

-
-
-

tenant object that needs to be created or updated.

-

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

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

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

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

-
path - string - - - -
- tenant-id - -

Unique id relative to the cloud-region.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing tenant
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing tenant

+

delete an existing tenant

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28770,10 +26888,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - cloud-type + vserver-id -

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

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

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

query @@ -28800,10 +26916,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-name + vserver-name2 -

Readable name of tenant

query @@ -28815,10 +26930,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - tenant-context + prov-status -

This field will store the tenant context.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -28971,139 +27113,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - cloud-type - - -

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

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

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

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

Readable name of tenant

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

This field will store the tenant context.

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

Name of vserver

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

Alternative name of vserver

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

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

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - @@ -29143,7 +27152,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

-

vserver object that needs to be created or updated.

+

vserver object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -29664,55 +27673,9 @@ 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 + interface-name -

This field will store the tenant context.

query @@ -29724,10 +27687,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vserver-name + interface-id -

Name of vserver

query @@ -29739,10 +27701,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vserver-name2 + macaddr -

Alternative name of vserver

query @@ -29754,10 +27715,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + network-name -

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -29954,182 +27886,180 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30187,16 +28094,16 @@ 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}

+
update an existing l-interface
+

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

Tags: CloudInfrastructure
-

create or update an existing l-interface

+

update an existing l-interface

@@ -30205,13 +28112,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

l-interface object that needs to be updated.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30340,34 +28247,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
update an existing l-interface
-

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

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

update an existing l-interface

+

delete an existing l-interface

application/json application/xml

-
-
-

l-interface object that needs to be created or updated.

-

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

MAC address for the interface

+

Unique identifier for this vserver relative to its tenant

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
@@ -30461,6 +28356,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30492,24 +28403,19 @@ 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}

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

delete an existing l-interface

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -30604,12 +28510,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - - - - - - - - - - - - - - - - - - - - - + +
- resource-version + l3-interface-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -30627,6 +28533,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -30650,18 +28579,35 @@ 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}

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

+

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

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
+
@@ -30770,220 +28716,338 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

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

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

+

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

querypath string +
- owner-defined-type + cloud-region-id -

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

+

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

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

Readable name of tenant

+

Unique id relative to the cloud-region.

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

This field will store the tenant context.

+

Unique identifier for this vserver relative to its tenant

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

Name of vserver

+

Name given to the interface

querypath string +
- vserver-name2 + l3-interface-ipv4-address -

Alternative name of vserver

+

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

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31047,17 +29089,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}

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

+

see node definition for valid relationships

@@ -31066,13 +29108,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31216,35 +29258,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing l3-interface-ipv4-address-list
-

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

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

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.

-

-
- -
- 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 +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name given to the interface

querypath - integer + string +
- neutron-network-id + l3-interface-ipv4-address -

Neutron network id of the interface that address belongs to

+

IP address

querypath string +
- neutron-subnet-id + resource-version -

Neutron id of subnet that address belongs to

+

resource-version for concurrency

query @@ -30991,6 +29055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
@@ -31370,7 +29400,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31385,24 +29415,19 @@ 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}

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

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

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
@@ -31497,7 +29522,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

@@ -31511,14 +29536,190 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

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

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

+
path + string + + + +
- resource-version + cloud-region-id -

resource-version for concurrency

+

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

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

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

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

IP address

+
path string @@ -31543,7 +29744,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31558,17 +29759,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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

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

@@ -31577,13 +29778,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

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

@@ -31682,7 +29883,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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31727,17 +29928,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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

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

@@ -31839,7 +30040,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

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -31884,19 +30101,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}/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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+ +
+
+
@@ -32005,227 +30239,161 @@ 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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32282,17 +30427,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}

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

+

see node definition for valid relationships

@@ -32301,13 +30446,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

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

@@ -32404,22 +30549,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- cloud-type - -

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

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

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

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

Readable name of tenant

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

This field will store the tenant context.

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

Name of vserver

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

Alternative name of vserver

-
query - string - - -
- prov-status + 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 +
- 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-ipv6-address - -

IP address

-
path - string - - - -
@@ -32436,7 +30565,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32451,35 +30580,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/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 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
-

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.

-

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

IP address

-
path - string - - - -
@@ -32605,7 +30706,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32620,24 +30721,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/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 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
-

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

+

returns sriov-vfs

-
- -

application/json application/xml -

-
@@ -32732,26 +30828,65 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + + + + + + + + + + + + + + + + + + + + + + @@ -32771,6 +30905,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32793,36 +30950,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 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
-

see node definition for valid relationships

+

returns sriov-vf

-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
- -
-
-
- l3-interface-ipv6-address + pci-id -

IP address

pathquery string -
- resource-version + vf-vlan-filter + + query + string + + +
+ vf-mac-filter + + query + string + + +
+ vf-vlan-strip + + query + boolean + + +
+ neutron-network-id -

resource-version for concurrency

query @@ -32759,7 +30894,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
@@ -32917,10 +31057,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 @@ -32940,6 +31080,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
default @@ -32947,7 +31110,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -32962,23 +31125,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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-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
-

delete an existing relationship

+

create or update an existing sriov-vf

application/json application/xml

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
@@ -33074,10 +31249,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 @@ -33104,7 +31279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33119,17 +31294,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

+
update an existing sriov-vf
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing sriov-vf

@@ -33138,13 +31313,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterface.json)

+

sriov-vf object that needs to be updated.

@@ -33241,6 +31416,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
@@ -33257,7 +31448,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33272,17 +31463,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 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

@@ -33382,6 +31573,38 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ pci-id + +

PCI ID used to identify the sriov-vf

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33413,19 +31636,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns sriov-vfs
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

returns sriov-vfs

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+ +
+
+
@@ -33520,180 +31760,175 @@ 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 + pci-id -

This field will store the tenant context.

+

PCI ID used to identify the sriov-vf

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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -33750,17 +31962,17 @@ 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}

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

+

returns vlans

@@ -33857,86 +32069,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- 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 +
- prov-status + tenant-id -

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

+

Unique id relative to the cloud-region.

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- 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 + pci-id -

Name of the network

+

PCI ID used to identify the sriov-vf

querypath string +
- pci-id - -

PCI ID used to identify the sriov-vf

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

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

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

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

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

Readable name of tenant

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

This field will store the tenant context.

-
query - string - - -
- vserver-name + vlan-interface -

Name of vserver

query @@ -33948,14 +32083,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vserver-name2 + vlan-id-inner -

Alternative name of vserver

query - string + integer @@ -33963,10 +32097,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vpn-key -

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

query @@ -33976,137 +32109,179 @@ 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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

returns vlan

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - + - + - + - + - + - - - - - - - - + @@ -34135,7 +32310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -34148,7 +32323,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34163,17 +32338,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}

+
create or update an existing vlan
+

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

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

create or update an existing vlan

@@ -34182,13 +32357,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

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

@@ -34287,10 +32462,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 + cloud-owner -

ID of interface

+

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

querypath string +
- macaddr + cloud-region-id -

MAC address for the interface

+

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

querypath string +
- network-name + tenant-id -

Name of the network

+

Unique id relative to the cloud-region.

querypath string +
- vf-vlan-filter + vserver-id -

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

+

Unique identifier for this vserver relative to its tenant

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 given to the 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 + vlan-interface -

Neutron network id of the interface

+

String that identifies the interface

querypath string +
- pci-id + vlan-interface -

PCI ID used to identify the sriov-vf

+

String that identifies the interface

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34332,17 +32507,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

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

+
update an existing vlan
+

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

Tags: CloudInfrastructure
-

update an existing sriov-vf

+

update an existing vlan

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

-

sriov-vf object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -34456,10 +32631,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 @@ -34486,7 +32661,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34501,17 +32676,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 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 sriov-vf

+

delete an existing vlan

@@ -34613,10 +32788,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 @@ -34659,7 +32834,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34674,17 +32849,208 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/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

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

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

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

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

+
path + string + + + +
+ tenant-id + +

Unique id relative to the cloud-region.

+
path + string + + + +
+ vserver-id + +

Unique identifier for this vserver relative to its tenant

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ vlan-interface + +

String that identifies the interface

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

IP address

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

application/json application/xml +

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

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

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

@@ -34693,13 +33059,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceSriovVfsSriovVf.json)

+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

@@ -34798,10 +33164,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 @@ -34828,7 +33210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -34843,23 +33225,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

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

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

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

application/json application/xml

+
+
+

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

+

+
+ +
@@ -34955,10 +33349,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 @@ -34985,7 +33395,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35000,19 +33410,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vlans
-

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

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

returns vlans

+

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

+
+ +

application/json application/xml +

+
@@ -35107,40 +33522,42 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + + +
- cloud-type + vlan-interface -

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

+

String that identifies the interface

querypath string +
- owner-defined-type + l3-interface-ipv4-address -

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

+

IP address

querypath string +
- tenant-name + resource-version -

Readable name of tenant

+

resource-version for concurrency

query @@ -35148,139 +33565,192 @@ 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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -35322,7 +33769,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35337,19 +33784,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 relationship
+

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

Tags: CloudInfrastructure
-

returns vlan

+

delete an existing relationship

+
+ +

application/json application/xml +

+
- tenant-context + cloud-owner -

This field will store the tenant context.

+

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

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

Name of vserver

+

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

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

Alternative name of vserver

+

Unique id relative to the cloud-region.

querypath string +
- prov-status + vserver-id -

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

+

Unique identifier for this vserver relative to its tenant

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- 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-ipv4-address -

Name of the network

+

IP address

querypath string +
@@ -35460,210 +33912,186 @@ 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 + l3-interface-ipv4-address -

This field will store the tenant context.

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - - + - + - + - - - - - - - - + @@ -35692,7 +34120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -35705,7 +34133,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35720,17 +34148,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}

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

+

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

@@ -35739,13 +34167,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlan.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -35858,6 +34286,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+ + + + + +
- 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 +
- prov-status + tenant-id -

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

+

Unique id relative to the cloud-region.

querypath string +
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- 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 + vlan-interface -

Name of the network

+

String that identifies the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key + l3-interface-ipv6-address -

This indicates the customers VPN ID associated with this vlan

+

IP address

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

IP address

+
path + string + + + +
@@ -35874,7 +34318,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -35889,17 +34333,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

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

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

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

Tags: CloudInfrastructure
-

update an existing vlan

+

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

@@ -35908,13 +34352,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 updated.

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

IP address

+
path + string + + + +
@@ -36043,7 +34503,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36058,17 +34518,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 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 vlan

+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36231,19 +34707,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}/vlans/vlan/{vlan-interface}/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}/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
-

returns l3-interface-ipv4-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+ +
+
+
@@ -36354,7 +34847,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

@@ -36368,257 +34861,177 @@ 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}/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 +

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36675,17 +35065,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}/vlans/vlan/{vlan-interface}/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}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
-

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

+

see node definition for valid relationships

@@ -36694,13 +35084,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

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

@@ -36813,22 +35203,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - -
- cloud-type - -

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

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

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

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

Readable name of tenant

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

This field will store the tenant context.

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

Name of vserver

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

Alternative name of vserver

-
query - string - - -
- prov-status + 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 +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key + interface-name -

This indicates the customers VPN ID associated with this vlan

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv6-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -36845,7 +35219,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -36860,35 +35234,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

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

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

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.

-

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

IP address

-
path - string - - - -
@@ -37030,7 +35376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37045,23 +35391,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/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}

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

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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

+
+
+
+ +
+
@@ -37139,12 +35497,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}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - + +
- interface-name + cloud-owner -

Name given to the interface

+

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

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

String that identifies the interface

+

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

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

IP address

+

Unique id relative to the cloud-region.

path @@ -37189,12 +35608,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 @@ -37219,7 +35638,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37234,36 +35653,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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
@@ -37342,50 +35744,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - + @@ -37397,6 +35765,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volumes +
+
+
+ +
default @@ -37404,7 +35795,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37419,24 +35810,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

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

delete an existing relationship

+

returns volume

-
- -

application/json application/xml -

-
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address + volume-id -

IP address

pathquery string -
@@ -37515,42 +35901,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /volume +
+
+
+ +
default @@ -37577,7 +35954,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -37592,19 +35969,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}

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

returns l3-interface-ipv6-address-list

+

create or update an existing volume

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+
+ /volume +
+
+
+
@@ -37683,10 +36077,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- interface-name + volume-id -

Name given to the interface

+

Unique ID of block storage volume relative to the vserver.

path @@ -37697,12 +36091,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing volume
+

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

+ Tags: + CloudInfrastructure +
+
+
+

update an existing volume

+ +
+
+ +

application/json application/xml +

+
+
+

volume object that needs to be updated.

+

+
+
+
+
+ /volume +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - + - + @@ -37991,29 +36253,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38036,35 +36275,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/cloud-regions/cloud-region/{cloud-owner}/{cloud-region-id}/tenants/tenant/{tenant-id}/vservers/vserver/{vserver-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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

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

+

delete an existing volume

application/json application/xml

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
- -
- vlan-interface + cloud-owner -

String that identifies the interface

+

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

path @@ -37715,10 +36182,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + cloud-region-id -

IP address

+

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

path @@ -37731,255 +36198,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 - - -
- 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 + tenant-id -

This indicates the customers VPN ID associated with this vlan

+

Unique id relative to the cloud-region.

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id + vserver-id -

Neutron network id of the interface that address belongs to

+

Unique identifier for this vserver relative to its tenant

querypath string +
- neutron-subnet-id + volume-id -

Neutron id of subnet that address belongs to

+

Unique ID of block storage volume relative to the vserver.

querypath string +
@@ -38144,26 +36371,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 + volume-id -

String that identifies the interface

+

Unique ID of block storage volume relative to the vserver.

path @@ -38176,12 +36387,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 @@ -38206,7 +36417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38221,17 +36432,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/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}/volumes/volume/{volume-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

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

+

see node definition for valid relationships

@@ -38240,13 +36451,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.

+

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

@@ -38329,42 +36540,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + volume-id -

IP address

+

Unique ID of block storage volume relative to the vserver.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38406,17 +36585,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

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

+

delete an existing relationship

@@ -38502,10 +36681,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + volume-id -

Name given to the interface

+

Unique ID of block storage volume relative to the vserver.

path @@ -38516,12 +36695,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 vip-ipv4-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vip-ipv4-address-list

+ +
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vlan-interface + cloud-owner -

String that identifies the interface

+

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

path @@ -38534,10 +36769,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + cloud-region-id -

IP address

+

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

path @@ -38550,12 +36785,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + vip-ipv4-address -

resource-version for concurrency

+

IP address

querypath string @@ -38573,6 +36808,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38595,17 +36853,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 vip-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

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

@@ -38614,13 +36872,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

@@ -38671,71 +36929,7 @@ 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 - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv6-address + vip-ipv4-address

IP address

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38780,23 +36974,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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing vip-ipv4-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing vip-ipv4-address-list

application/json application/xml

+
+
+

vip-ipv4-address-list object that needs to be updated.

+

+
+ +
@@ -38844,10 +37050,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- tenant-id + vip-ipv4-address -

Unique id relative to the cloud-region.

+

IP address

path @@ -38858,12 +37064,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-ipv4-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing vip-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - - - - - - - - - - - - - - + +
- 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 @@ -38876,10 +37143,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 @@ -38892,10 +37159,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vip-ipv4-address -

String that identifies the interface

+

IP address

path @@ -38908,12 +37175,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 @@ -38938,7 +37205,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -38953,11 +37220,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}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -38972,7 +37239,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -39029,58 +37296,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 - -

Name given to the interface

-
path - string - - - -
- vlan-interface + vip-ipv4-address -

String that identifies the interface

+

IP address

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39122,11 +37341,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}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -39186,10 +37405,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-id + vip-ipv4-address -

Unique id relative to the cloud-region.

+

IP address

path @@ -39200,12 +37419,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 vip-ipv6-address-list
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns vip-ipv6-address-list

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - -
- 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 @@ -39218,10 +37493,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 @@ -39234,10 +37509,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vlan-interface + vip-ipv6-address -

String that identifies the interface

+

IP address

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

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39279,17 +37577,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}/relationship-list/relationship

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

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

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

@@ -39298,13 +37596,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserver.json)

+

vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

@@ -39355,26 +37653,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 + vip-ipv6-address -

Unique identifier for this vserver relative to its tenant

+

IP address

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39416,23 +37698,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}/relationship-list/relationship

+
update an existing vip-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

update an existing vip-ipv6-address-list

application/json application/xml

+
+
+

vip-ipv6-address-list object that needs to be updated.

+

+
+ +
@@ -39480,26 +37774,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -59204,7 +51613,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -59217,7 +51626,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -59232,19 +51641,36 @@ 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}

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

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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
+
- tenant-id + vip-ipv6-address -

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

+

IP address

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39541,19 +37819,24 @@ 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

+
delete an existing vip-ipv6-address-list
+

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

Tags: CloudInfrastructure
-

returns volumes

+

delete an existing vip-ipv6-address-list

+
+ +

application/json application/xml +

+
@@ -39600,26 +37883,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 + vip-ipv6-address -

Unique identifier for this vserver relative to its tenant

+

IP address

path @@ -39632,55 +37899,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 + resource-version -

This field will store the tenant context.

+

resource-version for concurrency

query @@ -39688,79 +37910,128 @@ 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}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

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

+

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

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /volumes -
-
-
- -
default @@ -39802,7 +38050,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -39817,19 +38065,24 @@ 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}

+
delete an existing relationship
+

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

Tags: CloudInfrastructure
-

returns volume

+

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 +
- prov-status + vip-ipv6-address -

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

+

IP address

querypath string -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - +
@@ -39876,10 +38129,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- tenant-id + vip-ipv6-address -

Unique id relative to the cloud-region.

+

IP address

path @@ -39890,12 +38143,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 volume-groups
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns volume-groups

+ +
+
+ + + + + + + + + + + + +
- 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 @@ -39908,10 +38217,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- volume-id + cloud-region-id -

Unique ID of block storage volume relative to the vserver.

+

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

path @@ -39924,10 +38233,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-type + volume-group-id -

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

query @@ -39939,10 +38247,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + volume-group-name -

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

query @@ -39954,10 +38261,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-name + heat-stack-id -

Readable name of tenant

query @@ -39969,10 +38275,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- tenant-context + vnf-type -

This field will store the tenant context.

query @@ -39982,77 +38287,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns volume-group
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns volume-group

+ +
+
+ + + + + + + + + + + - + - + - + - - - - - - - - - - - - - - @@ -40081,7 +38440,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -40094,7 +38453,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40109,17 +38468,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 volume-group
+

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

Tags: CloudInfrastructure
-

create or update an existing volume

+

create or update an existing volume-group

@@ -40128,13 +38487,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionTenantsTenantVserversVserverVolumesVolume.json)

+

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

@@ -40185,42 +38544,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- 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 +
- prov-status + volume-group-id -

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

+

Unique ID of volume-group.

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

Unique id relative to the cloud-region.

-
path - string - - - -
- vserver-id - -

Unique identifier for this vserver relative to its tenant

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

Unique ID of block storage volume relative to the vserver.

+

Unique ID of volume-group.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40262,17 +38589,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing volume
-

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

+
update an existing volume-group
+

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

Tags: CloudInfrastructure
-

update an existing volume

+

update an existing volume-group

@@ -40281,13 +38608,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.

+

volume-group object that needs to be updated.

@@ -40338,42 +38665,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 - - - -
- volume-id + volume-group-id -

Unique ID of block storage volume relative to the vserver.

+

Unique ID of volume-group.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40415,17 +38710,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 volume-group
+

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

Tags: CloudInfrastructure
-

delete an existing volume

+

delete an existing volume-group

@@ -40479,42 +38774,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 - - - -
- volume-id + volume-group-id -

Unique ID of block storage volume relative to the vserver.

+

Unique ID of volume-group.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40572,11 +38835,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}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -40591,7 +38854,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -40648,42 +38911,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 - - - -
- volume-id + volume-group-id -

Unique ID of block storage volume relative to the vserver.

+

Unique ID of volume-group.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40725,11 +38956,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}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -40789,42 +39020,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 - - - -
- volume-id + volume-group-id -

Unique ID of block storage volume relative to the vserver.

+

Unique ID of volume-group.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -40866,17 +39065,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vip-ipv4-address-list
-

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

+
returns complexes
+

GET /cloud-infrastructure/complexes

Tags: CloudInfrastructure
-

returns vip-ipv4-address-list

+

returns complexes

@@ -40893,58 +39092,9 @@ 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 - - - -
- vip-ipv4-address - -

IP address

-
path - string - - - -
- cloud-type + physical-location-id -

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

query @@ -40956,10 +39106,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- owner-defined-type + data-center-code -

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

query @@ -40971,25 +39120,9 @@ 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 + complex-name -

Neutron network id of the interface that address belongs to

query @@ -41001,10 +39134,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- neutron-subnet-id + identity-url -

Neutron id of subnet that address belongs to

query @@ -41040,7 +39172,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -41053,7 +39185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41068,36 +39200,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vip-ipv4-address-list
-

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

+
returns complex
+

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

Tags: CloudInfrastructure
-

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

+

returns complex

-
- -

application/json application/xml -

-
-
-

vip-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv4AddressList.json)

-

-
- -
-
@@ -41112,42 +39227,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 - - - -
- vip-ipv4-address + physical-location-id -

IP address

+

Unique identifier for physical location, e.g., CLLI

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

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /complex +
+
+
+ +
default @@ -41174,7 +39280,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41189,17 +39295,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vip-ipv4-address-list
-

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

+
create or update an existing complex
+

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

Tags: CloudInfrastructure
-

update an existing vip-ipv4-address-list

+

create or update an existing complex

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

-

vip-ipv4-address-list object that needs to be created or updated.

+

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

@@ -41233,42 +39339,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 - - - -
- vip-ipv4-address + physical-location-id -

IP address

+

Unique identifier for physical location, e.g., CLLI

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41310,23 +39384,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vip-ipv4-address-list
-

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

+
update an existing complex
+

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

Tags: CloudInfrastructure
-

delete an existing vip-ipv4-address-list

+

update an existing complex

application/json application/xml

+
+
+

complex object that needs to be updated.

+

+
+
+
+
+ /complex +
+
+
@@ -41342,42 +39428,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 - - - -
- vip-ipv4-address + physical-location-id -

IP address

+

Unique identifier for physical location, e.g., CLLI

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

resource-version for concurrency

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41435,35 +39473,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}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

+
delete an existing complex
+

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

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

delete an existing complex

application/json application/xml

-
-
-

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

-

-
-
-
- -
-
@@ -41479,26 +39505,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 + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -41511,12 +39521,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -41541,7 +39551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41556,24 +39566,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}/vip-ipv4-address-list/{vip-ipv4-address}/relationship-list/relationship

+
returns ctag-pools
+

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

Tags: CloudInfrastructure
-

delete an existing relationship

+

returns ctag-pools

-
- -

application/json application/xml -

-
@@ -41588,26 +39593,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - + @@ -41643,6 +39630,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41665,17 +39675,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns vip-ipv6-address-list
-

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

+
returns ctag-pool
+

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

Tags: CloudInfrastructure
-

returns vip-ipv6-address-list

+

returns ctag-pool

@@ -41692,10 +39702,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -41620,18 +39609,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv4-address + availability-zone-name -

IP address

pathquery string -
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -41708,10 +39718,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

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

+

The Target provider edge router

path @@ -41724,10 +39734,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

path @@ -41738,81 +39748,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 - - -
- 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 - - -
@@ -41839,7 +39774,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -41852,7 +39787,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41867,17 +39802,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing vip-ipv6-address-list
-

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

+
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 vip-ipv6-address-list

+

create or update an existing ctag-pool

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

-

vip-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVipIpv6AddressList.json)

+

ctag-pool object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

@@ -41911,10 +39846,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -41927,10 +39862,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

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

+

The Target provider edge router

path @@ -41943,10 +39878,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -41988,17 +39923,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vip-ipv6-address-list
-

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

+
update an existing ctag-pool
+

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

Tags: CloudInfrastructure
-

update an existing vip-ipv6-address-list

+

update an existing ctag-pool

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

-

vip-ipv6-address-list object that needs to be created or updated.

+

ctag-pool object that needs to be updated.

@@ -42032,10 +39967,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -42048,10 +39983,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

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

+

The Target provider edge router

path @@ -42064,10 +39999,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42109,17 +40044,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vip-ipv6-address-list
-

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

+
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 vip-ipv6-address-list

+

delete an existing ctag-pool

@@ -42141,10 +40076,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -42157,10 +40092,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

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

+

The Target provider edge router

path @@ -42173,10 +40108,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42234,11 +40169,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}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -42253,7 +40188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -42278,10 +40213,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -42294,10 +40229,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

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

+

The Target provider edge router

path @@ -42310,10 +40245,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42355,11 +40290,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}/vip-ipv6-address-list/{vip-ipv6-address}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -42387,10 +40322,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -42403,10 +40338,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- cloud-region-id + target-pe -

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

+

The Target provider edge router

path @@ -42419,10 +40354,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vip-ipv6-address + availability-zone-name -

IP address

+

Name of the availability zone

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42464,19 +40399,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/complexes/complex/{physical-location-id}/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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplex.json)

+

+
+
+
+ +
+
+
@@ -42491,26 +40443,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 + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -42521,36 +40457,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 - - -
@@ -42560,29 +40466,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42605,19 +40488,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/complexes/complex/{physical-location-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns volume-group

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -42632,10 +40520,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- cloud-owner + physical-location-id -

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

+

Unique identifier for physical location, e.g., CLLI

path @@ -42646,28 +40534,161 @@ 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 network-profiles
+

GET /cloud-infrastructure/network-profiles

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profiles

+ +
+
+ + + + + + + + + + + - + + +
- cloud-region-id + nm-profile-name -

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

pathquery string -
+
+ +
+

application/json application/xml +

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

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns network-profile
+

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

+ Tags: + CloudInfrastructure +
+
+
+

returns network-profile

+ +
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- volume-group-id + nm-profile-name -

Unique ID of volume-group.

+

Unique name of network profile.

path @@ -42678,81 +40699,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 - - -
- 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 - - -
@@ -42779,7 +40725,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -42792,7 +40738,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42807,17 +40753,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing volume-group
-

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

+
create or update an existing network-profile
+

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

Tags: CloudInfrastructure
-

create or update an existing volume-group

+

create or update an existing network-profile

@@ -42826,13 +40772,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureCloudRegionsCloudRegionVolumeGroupsVolumeGroup.json)

+

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

@@ -42851,42 +40797,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 - - - -
- volume-group-id + nm-profile-name -

Unique ID of volume-group.

+

Unique name of network profile.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -42928,17 +40842,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing volume-group
-

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

+
update an existing network-profile
+

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

Tags: CloudInfrastructure
-

update an existing volume-group

+

update an existing network-profile

@@ -42947,13 +40861,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.

+

network-profile object that needs to be updated.

@@ -42972,42 +40886,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 - - - -
- volume-group-id + nm-profile-name -

Unique ID of volume-group.

+

Unique name of network profile.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43049,17 +40931,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 network-profile
+

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

Tags: CloudInfrastructure
-

delete an existing volume-group

+

delete an existing network-profile

@@ -43081,42 +40963,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 - - - -
- volume-group-id + nm-profile-name -

Unique ID of volume-group.

+

Unique name of network profile.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43174,11 +41024,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}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -43193,7 +41043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

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

+

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

@@ -43218,42 +41068,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 - - - -
- volume-group-id + nm-profile-name -

Unique ID of volume-group.

+

Unique name of network profile.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43295,11 +41113,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}/volume-groups/volume-group/{volume-group-id}/relationship-list/relationship

+

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

Tags: CloudInfrastructure
@@ -43327,42 +41145,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 - - - -
- volume-group-id + nm-profile-name -

Unique ID of volume-group.

+

Unique name of network profile.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43404,19 +41190,48 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns complexes
-

GET /cloud-infrastructure/complexes

+
returns operational-environments
+

GET /cloud-infrastructure/operational-environments

Tags: CloudInfrastructure
-

returns complexes

+

returns operational-environments

+
+ + + + + + + + + + + + + + + + + + + +
+ operational-environment-id + + query + string + + +
+

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

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43468,17 +41283,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns complex
-

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

+
returns operational-environment
+

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

Tags: CloudInfrastructure
-

returns complex

+

returns operational-environment

@@ -43495,10 +41310,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + operational-environment-id -

Unique identifier for physical location, e.g., CLLI

+

UUID of an operational environment

path @@ -43509,51 +41324,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- data-center-code - -

Data center code which can be an alternate way to identify a complex

-
query - string - - -
- complex-name - -

Gamma complex name for LCP instance.

-
query - string - - -
- identity-url - -

URL of the keystone identity service

-
query - string - - -
@@ -43580,7 +41350,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -43593,7 +41363,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43608,17 +41378,17 @@ 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}

+
create or update an existing operational-environment
+

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

Tags: CloudInfrastructure
-

create or update an existing complex

+

create or update an existing operational-environment

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

-

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

+

operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)

@@ -43652,10 +41422,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + operational-environment-id -

Unique identifier for physical location, e.g., CLLI

+

UUID of an operational environment

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43697,17 +41467,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing complex
-

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

+
update an existing operational-environment
+

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

Tags: CloudInfrastructure
-

update an existing complex

+

update an existing operational-environment

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

-

complex object that needs to be created or updated.

+

operational-environment object that needs to be updated.

@@ -43741,10 +41511,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + operational-environment-id -

Unique identifier for physical location, e.g., CLLI

+

UUID of an operational environment

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43786,17 +41556,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing complex
-

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

+
delete an existing operational-environment
+

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

Tags: CloudInfrastructure
-

delete an existing complex

+

delete an existing operational-environment

@@ -43818,10 +41588,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id + operational-environment-id -

Unique identifier for physical location, e.g., CLLI

+

UUID of an operational environment

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -43879,19 +41649,36 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pools
-

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

+
see node definition for valid relationships
+

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

Tags: CloudInfrastructure
-

returns ctag-pools

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

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

+

+
+
+
+ +
+
+
@@ -43906,10 +41693,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- physical-location-id + operational-environment-id -

Unique identifier for physical location, e.g., CLLI

+

UUID of an operational environment

path @@ -43920,49 +41707,81 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

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

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

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

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

-
- 200 OK - -
-
-
-
-

successful operation

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44019,17 +41815,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns ctag-pool
-

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

+
returns pservers
+

GET /cloud-infrastructure/pservers

Tags: CloudInfrastructure
-

returns ctag-pool

+

returns pservers

@@ -44046,62 +41842,55 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- + - + - + + +
- data-center-code - -

Data center code which can be an alternate way to identify a complex

-
query - string - - -
- complex-name - -

Gamma complex name for LCP instance.

-
query - string - - -
- identity-url + operational-environment-id -

URL of the keystone identity service

+

UUID of an operational environment

querypath string +
- physical-location-id + hostname -

Unique identifier for physical location, e.g., CLLI

pathquery string -
- target-pe + inv-status -

The Target provider edge router

pathquery string -
- availability-zone-name + pserver-id -

Name of the availability zone

pathquery string -
- data-center-code + in-maint -

Data center code which can be an alternate way to identify a complex

query - string + boolean @@ -44109,10 +41898,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- complex-name + pserver-name2 -

Gamma complex name for LCP instance.

query @@ -44122,19 +41910,99 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

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

+ +
+
+ + + + + + + + + + + - + @@ -44163,7 +42031,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -44176,7 +42044,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44191,17 +42059,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 pserver
+

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

Tags: CloudInfrastructure
-

create or update an existing ctag-pool

+

create or update an existing pserver

@@ -44210,13 +42078,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureComplexesComplexCtagPoolsCtagPool.json)

+

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

@@ -44235,42 +42103,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- identity-url + hostname -

URL of the keystone identity service

+

Value from executing hostname on the compute node.

querypath string +
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe - -

The Target provider edge router

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

Name of the availability zone

+

Value from executing hostname on the compute node.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44312,17 +42148,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing ctag-pool
-

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

+
update an existing pserver
+

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

Tags: CloudInfrastructure
-

update an existing ctag-pool

+

update an existing pserver

@@ -44331,13 +42167,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.

+

pserver object that needs to be updated.

@@ -44356,42 +42192,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe - -

The Target provider edge router

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

Name of the availability zone

+

Value from executing hostname on the compute node.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44433,17 +42237,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 pserver
+

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

Tags: CloudInfrastructure
-

delete an existing ctag-pool

+

delete an existing pserver

@@ -44465,42 +42269,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe - -

The Target provider edge router

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

Name of the availability zone

+

Value from executing hostname on the compute node.

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

Response codes found in response codes.

+

Response codes found in response codes.

@@ -44558,4594 +42330,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/complexes/complex/{physical-location-id}/ctag-pools/ctag-pool/{target-pe}/{availability-zone-name}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe - -

The Target provider edge router

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

Name of the availability zone

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

-
path - string - - - -
- target-pe - -

The Target provider edge router

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

Name of the availability zone

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - -
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- physical-location-id - -

Unique identifier for physical location, e.g., CLLI

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns network-profiles
-

GET /cloud-infrastructure/network-profiles

- Tags: - CloudInfrastructure -
-
-
-

returns network-profiles

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns network-profile
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns network-profile

- -
-
- - - - - - - - - - - - - - - - - - - -
- nm-profile-name - -

Unique name of network profile.

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

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing network-profile
-

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

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing network-profile

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- nm-profile-name - -

Unique name of network profile.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing network-profile
-

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

- Tags: - CloudInfrastructure -
-
-
-

update an existing network-profile

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- nm-profile-name - -

Unique name of network profile.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing network-profile
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing network-profile

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- nm-profile-name - -

Unique name of network profile.

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

resource-version for concurrency

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - -
- nm-profile-name - -

Unique name of network profile.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- nm-profile-name - -

Unique name of network profile.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns operational-environments
-

GET /cloud-infrastructure/operational-environments

- Tags: - CloudInfrastructure -
-
-
-

returns operational-environments

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns operational-environment
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns operational-environment

- -
-
- - - - - - - - - - - - - - - - - - - -
- operational-environment-id - -

UUID of an operational environment

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

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
- -
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing operational-environment
-

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

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing operational-environment

- -
-
- -

application/json application/xml -

-
-
-

operational-environment object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructureOperationalEnvironmentsOperationalEnvironment.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - -
- operational-environment-id - -

UUID of an operational environment

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing operational-environment
-

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

- Tags: - CloudInfrastructure -
-
-
-

update an existing operational-environment

- -
-
- -

application/json application/xml -

-
-
-

operational-environment object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - -
- operational-environment-id - -

UUID of an operational environment

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing operational-environment
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing operational-environment

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- operational-environment-id - -

UUID of an operational environment

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

resource-version for concurrency

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - -
- operational-environment-id - -

UUID of an operational environment

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - -
- operational-environment-id - -

UUID of an operational environment

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns pservers
-

GET /cloud-infrastructure/pservers

- Tags: - CloudInfrastructure -
-
-
-

returns pservers

- -
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /pservers -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns pserver
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns pserver

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /pserver -
-
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
create or update an existing pserver
-

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

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing pserver

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
-
-
-
- /pserver -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing pserver
-

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

- Tags: - CloudInfrastructure -
-
-
-

update an existing pserver

- -
-
- -

application/json application/xml -

-
-
-

pserver object that needs to be created or updated.

-

-
-
-
-
- /pserver -
-
-
-
-
- - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing pserver
-

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing pserver

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

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

resource-version for concurrency

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns lag-interfaces
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns lag-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

returns lag-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing lag-interface

- -
-
- -

application/json application/xml -

-
-
-

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing lag-interface
-

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

- Tags: - CloudInfrastructure -
-
-
-

update an existing lag-interface

- -
-
- -

application/json application/xml -

-
-
-

lag-interface object that needs to be created or updated.

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing lag-interface

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

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

resource-version for concurrency

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l-interfaces
-

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

- Tags: - CloudInfrastructure -
-
-
-

returns l-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

returns l-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing l-interface

- -
-
- -

application/json application/xml -

-
-
-

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l-interface
-

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

- Tags: - CloudInfrastructure -
-
-
-

update an existing l-interface

- -
-
- -

application/json application/xml -

-
-
-

l-interface object that needs to be created or updated.

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

delete an existing l-interface

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

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

resource-version for concurrency

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

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

IP address

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

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

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

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

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

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

IP address

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

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

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

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

- Tags: - CloudInfrastructure -
-
-
-

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

- -
-
- -

application/json application/xml -

-
-
-

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

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv4-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - CloudInfrastructure -
-
-
-

delete an existing l3-interface-ipv4-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

see node definition for valid relationships

- -
-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
-
-
- -
-
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

- Tags: - CloudInfrastructure -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
+ +
-
returns l3-interface-ipv6-address-list
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns lag-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

returns lag-interfaces

@@ -49180,100 +42375,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 - - - -
- 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 @@ -49288,7 +42390,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -49303,97 +42404,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-role -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

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 @@ -49429,7 +42439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -49442,422 +42452,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - - - - - -
-
-
create or update an existing l3-interface-ipv6-address-list
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - CloudInfrastructure -
-
-
-

create or update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - CloudInfrastructure -
-
-
-

update an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

- Tags: - CloudInfrastructure -
-
-
-

delete an existing l3-interface-ipv6-address-list

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv6-address - -

IP address

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -49872,86 +42467,37 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
returns lag-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

returns lag-interface

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

-

-
-
-
- -
-
-
- - - - - - - - - - - - - - - - - - - - - + + + + + + + - - - - - - -
- hostname - -

Value from executing hostname on the compute node.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

path @@ -49964,10 +42510,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 @@ -49987,6 +42533,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -49994,7 +42563,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50009,23 +42578,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
create or update an existing lag-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing relationship

+

create or update an existing lag-interface

application/json application/xml

+
+
+

lag-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

+
+
+
+ +
+
@@ -50071,38 +42652,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 - - - -
@@ -50119,7 +42668,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50134,17 +42683,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+
update an existing lag-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing lag-interface

@@ -50153,13 +42702,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

+

lag-interface object that needs to be updated.

@@ -50208,22 +42757,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 - - - -
@@ -50240,7 +42773,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50255,17 +42788,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

@@ -50319,12 +42852,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 @@ -50349,7 +42882,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50364,17 +42897,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

@@ -50426,97 +42959,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
-

Name given to the interface

-
path - string - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- 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 @@ -50531,7 +42973,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-id -

ID of interface

query @@ -50546,7 +42987,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen macaddr -

MAC address for the interface

query @@ -50561,7 +43001,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name -

Name of the network

query @@ -50597,7 +43036,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -50610,7 +43049,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50625,17 +43064,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

@@ -50698,216 +43137,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 - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter - -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

-
query - string - - -
- vf-mac-filter - -

When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.

-
query - string - - -
- vf-vlan-strip - -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

-
query - boolean - - -
- neutron-network-id - -

Neutron network id of the interface

-
query - string - - -
@@ -50934,7 +43163,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
@@ -50947,7 +43176,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -50962,17 +43191,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing sriov-vf
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
create or update an existing l-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

create or update an existing sriov-vf

+

create or update an existing l-interface

@@ -50981,13 +43210,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -51052,22 +43281,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 - - - -
@@ -51084,7 +43297,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51099,17 +43312,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
update an existing l-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

update an existing sriov-vf

+

update an existing l-interface

@@ -51118,13 +43331,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -51189,22 +43402,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 - - - -
@@ -51221,7 +43418,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51236,17 +43433,17 @@ 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}

+
delete an existing l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

delete an existing sriov-vf

+

delete an existing l-interface

@@ -51314,22 +43511,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
resource-version @@ -51362,7 +43543,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51377,36 +43558,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+
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
-

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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
- -
-
-
@@ -51469,10 +43633,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - + - + @@ -55458,7 +47303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -55471,7 +47316,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55486,19 +47331,36 @@ 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}

+
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 p-interface

+

create or update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
- pci-id + l3-interface-ipv4-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -51492,6 +43656,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -51499,7 +43686,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51514,23 +43701,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/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
-

delete an existing relationship

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -51594,10 +43793,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 @@ -51624,7 +43823,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51639,19 +43838,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

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

returns vlans

+

update an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be updated.

+

+
+ +
+
@@ -51714,136 +43930,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + @@ -51855,29 +43953,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlans -
-
-
- -
default @@ -51885,7 +43960,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -51900,19 +43975,24 @@ 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}

+
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
-

returns vlan

+

delete an existing l3-interface-ipv4-address-list

+
+ +

application/json application/xml +

+
- 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 + l3-interface-ipv4-address -

Name of the network

+

IP address

querypath string +
@@ -51975,10 +44055,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 @@ -51991,84 +44071,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role + resource-version -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

+

resource-version for concurrency

query @@ -52076,81 +44082,144 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - - - - - - - - + @@ -52162,29 +44231,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -52192,7 +44238,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52207,35 +44253,23 @@ 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}

+
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
-

create or update an existing vlan

+

delete an existing relationship

application/json application/xml

-
-
-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
-
- /vlan -
-
-
- interface-id + hostname -

ID of interface

+

Value from executing hostname on the compute node.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the link aggregate interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key + l3-interface-ipv4-address -

This indicates the customers VPN ID associated with this vlan

+

IP address

querypath string +
@@ -52299,10 +44333,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 @@ -52329,7 +44363,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52344,36 +44378,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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
-

update an existing vlan

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

vlan object that needs to be created or updated.

-

-
-
-
-
- /vlan -
-
-
-
@@ -52436,10 +44453,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 @@ -52459,6 +44476,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -52466,7 +44506,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52481,23 +44521,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing vlan
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/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
-

delete an existing 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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

+
+ +
@@ -52561,10 +44613,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 @@ -52575,22 +44627,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -52607,7 +44643,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52622,19 +44658,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}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

update an existing l3-interface-ipv6-address-list

+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
@@ -52697,23 +44750,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

@@ -52727,215 +44764,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 - - -
@@ -52945,29 +44773,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -52975,7 +44780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -52990,35 +44795,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 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
-

create or update an existing l3-interface-ipv4-address-list

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

-

-
- -
@@ -53082,10 +44875,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 @@ -53098,12 +44891,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 @@ -53128,7 +44921,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53143,17 +44936,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
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
-

update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -53162,13 +44955,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -53235,23 +45028,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

@@ -53281,7 +45058,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53296,17 +45073,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}/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
-

delete an existing l3-interface-ipv4-address-list

+

delete an existing relationship

@@ -53376,23 +45153,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

@@ -53406,22 +45167,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -53438,7 +45183,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53453,11 +45198,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-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}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -53472,7 +45217,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterface.json)

@@ -53543,38 +45288,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 - - - -
@@ -53591,7 +45304,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53606,11 +45319,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-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}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -53684,38 +45397,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 - - - -
@@ -53732,7 +45413,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -53747,17 +45428,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-vfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

returns sriov-vfs

@@ -53822,86 +45503,9 @@ 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 - -

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 + pci-id -

alternative pserver name

query @@ -53913,10 +45517,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-vlan-filter -

ID of interface

query @@ -53928,10 +45531,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + vf-mac-filter -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -53943,14 +45545,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-vlan-strip -

ID of interface

query - string + boolean @@ -53958,10 +45559,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + neutron-network-id -

MAC address for the interface

query @@ -53971,94 +45571,147 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-vf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-vf

+ +
+
+ + + + + + + + + + + - + - - - - - - - - + - - - - - - - - + - + @@ -54087,7 +45740,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -54100,7 +45753,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54115,17 +45768,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

@@ -54134,13 +45787,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -54207,26 +45860,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + +
- network-name + hostname -

Name of the network

+

Value from executing hostname on the compute node.

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 +
- 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 + pci-id -

Neutron id of subnet that address belongs to

+

PCI ID used to identify the sriov-vf

querypath 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 @@ -54253,7 +45890,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54268,17 +45905,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv6-address-list

+

update an existing sriov-vf

@@ -54287,13 +45924,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 updated.

@@ -54360,26 +45997,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 @@ -54406,7 +46027,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54421,17 +46042,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

@@ -54501,26 +46122,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 @@ -54563,7 +46168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54578,11 +46183,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
@@ -54597,7 +46202,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -54670,26 +46275,135 @@ 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 + +

PCI ID used to identify the sriov-vf

+
path + string + + + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
+ interface-name + +

Name that identifies the link aggregate interface

+
path + string + + + +
+ interface-name + +

Name given to the interface

+
path + string + + + +
+ pci-id -

IP address

+

PCI ID used to identify the sriov-vf

path @@ -54716,7 +46430,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54731,24 +46445,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-ipv6-address-list/{l3-interface-ipv6-address}/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
-

delete an existing relationship

+

returns vlans

-
- -

application/json application/xml -

-
@@ -54814,31 +46523,41 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vlan-interface - + - + + + + + + + + @@ -54850,6 +46569,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlans +
+
+
+ +
default @@ -54857,7 +46599,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -54872,36 +46614,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 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
-

see node definition for valid relationships

+

returns vlan

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
- -
-
-
-

String that identifies the interface

pathquery string -
- l3-interface-ipv6-address + vlan-id-inner -

IP address

pathquery + integer + + +
+ vpn-key + + query string -
@@ -54987,6 +46712,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
default @@ -54994,7 +46742,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55009,23 +46757,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/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
-

delete an existing relationship

+

create or update an existing vlan

application/json application/xml

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
@@ -55119,7 +46879,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55134,17 +46894,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

+
update an existing vlan
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing vlan

@@ -55153,13 +46913,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

+

vlan object that needs to be updated.

@@ -55208,6 +46968,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 + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
@@ -55224,7 +47016,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55239,17 +47031,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}/relationship-list/relationship

+
delete an existing vlan
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing vlan

@@ -55301,6 +47093,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 + + + +
+ vlan-interface + +

String that identifies the interface

+
path + string + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -55317,7 +47157,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55332,17 +47172,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns p-interfaces
-

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

+
returns 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-interfaces

+

returns l3-interface-ipv4-address-list

@@ -55375,61 +47215,66 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the link aggregate interface

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint + vlan-interface +

String that identifies the interface

querypath - boolean + string +
- pserver-name2 + l3-interface-ipv4-address -

alternative pserver name

+

IP address

querypath string +
@@ -55532,7 +47394,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - - - - - - - - + - + @@ -55626,29 +47462,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -55656,7 +47469,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55671,17 +47484,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
create or update an existing p-interface
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

create or update an existing p-interface

+

update an existing l3-interface-ipv4-address-list

@@ -55690,13 +47503,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -55734,7 +47547,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 @@ -55545,76 +47407,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 + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + vlan-interface -

alternative pserver name

+

String that identifies the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

path @@ -55745,85 +47558,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.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
update an existing p-interface
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

- Tags: - CloudInfrastructure -
-
-
-

update an existing p-interface

- -
-
- -

application/json application/xml -

-
-
-

p-interface object that needs to be created or updated.

-

-
-
-
- -
-
-
-
- - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- hostname + interface-name -

Value from executing hostname on the compute node.

+

Name given to the interface

path @@ -55836,10 +47576,26 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + vlan-interface -

Name that identifies the physical interface

+

String that identifies the interface

+
path + string + + + +
+ l3-interface-ipv4-address + +

IP address

path @@ -55866,7 +47622,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55881,17 +47637,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
delete an existing p-interface
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+
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 p-interface

+

delete an existing l3-interface-ipv4-address-list

@@ -55932,7 +47688,55 @@ 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 + 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 @@ -55975,7 +47779,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -55990,19 +47794,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}/p-interfaces/p-interface/{interface-name}/l-interfaces

+
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
-

returns l-interfaces

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -56036,7 +47857,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - - - - - - - - + - - - - - - - - + - + @@ -56130,29 +47925,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -56160,7 +47932,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56175,19 +47947,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}/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
-

returns l-interface

+

delete an existing relationship

+
+ +

application/json application/xml +

+
-

Name that identifies the physical interface

+

Name that identifies the link aggregate interface

path @@ -56049,76 +47870,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 + interface-name -

ID of Pserver

+

Name given to the interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + vlan-interface -

alternative pserver name

+

String that identifies the interface

querypath string +
- prov-status + l3-interface-ipv4-address -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

IP address

querypath string +
@@ -56221,7 +47998,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 @@ -56250,121 +48027,170 @@ 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.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv6-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

returns l3-interface-ipv6-address-list

+ +
+
+ + + + + + + + + + + - - - - - - - - + - + - + - + - + @@ -56393,7 +48219,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -56406,7 +48232,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56421,17 +48247,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}

+
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 l-interface

+

create or update an existing l3-interface-ipv6-address-list

@@ -56440,13 +48266,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -56484,7 +48310,39 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
- in-maint - - query - boolean - - -
- pserver-name2 + hostname -

alternative pserver name

+

Value from executing hostname on the compute node.

querypath string +
- prov-status + interface-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

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 +
-

Name that identifies the physical interface

+

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 @@ -56497,10 +48355,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name + l3-interface-ipv6-address -

Name given to the interface

+

IP address

path @@ -56527,7 +48385,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56542,17 +48400,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l-interface
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

update an existing l-interface

+

update an existing l3-interface-ipv6-address-list

@@ -56561,13 +48419,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 updated.

@@ -56605,7 +48463,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 @@ -56632,6 +48490,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 + + + +
@@ -56648,7 +48538,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56663,17 +48553,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 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 l-interface

+

delete an existing l3-interface-ipv6-address-list

@@ -56714,7 +48604,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 @@ -56741,6 +48631,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 + + + +
resource-version @@ -56773,7 +48695,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -56788,19 +48710,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}/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}/vlans/vlan/{vlan-interface}/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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+
+
+ +
+
+
@@ -56834,7 +48773,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 @@ -56863,10 +48802,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 @@ -56879,166 +48818,296 @@ 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 relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing relationship

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + - + - - - - - - - - + - + - + - + + +
- pserver-id + hostname -

ID of Pserver

+

Value from executing hostname on the compute node.

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name that identifies the link aggregate interface

querypath string +
- 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-ipv6-address -

MAC address for the interface

+

IP address

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+ Tags: + CloudInfrastructure +
+
+
+

see node definition for valid relationships

+ +
+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + - + @@ -57050,29 +49119,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -57080,7 +49126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57095,35 +49141,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
delete an existing relationship
+

DELETE /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-ipv4-address-list

+

delete an existing relationship

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

-

-
- -
- network-name + hostname -

Name of the network

+

Value from executing hostname on the compute node.

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the link aggregate interface

querypath - integer + string +
- 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 + vlan-interface -

Neutron id of subnet that address belongs to

+

String that identifies the interface

querypath string +
@@ -57158,7 +49192,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 @@ -57187,10 +49221,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 @@ -57217,7 +49251,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57232,17 +49266,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/lag-interfaces/lag-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv4-address-list

+

see node definition for valid relationships

@@ -57251,13 +49285,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverLagInterfacesLagInterface.json)

@@ -57295,7 +49329,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 @@ -57306,12 +49340,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 @@ -57324,10 +49419,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv4-address + interface-name -

IP address

+

Name that identifies the link aggregate interface

path @@ -57354,7 +49449,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57369,24 +49464,19 @@ 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}

+
returns p-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces

Tags: CloudInfrastructure
-

delete an existing l3-interface-ipv4-address-list

+

returns p-interfaces

-
- -

application/json application/xml -

-
@@ -57420,39 +49510,114 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen interface-name - + - + + +
-

Name that identifies the physical interface

pathquery string -
- interface-name + prov-status -

Name given to the interface

pathquery string -
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns p-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns p-interface

+ +
+
+ + + + + + + + + + + - + + +
- l3-interface-ipv4-address + hostname -

IP address

+

Value from executing hostname on the compute node.

path @@ -57465,12 +49630,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version + interface-name -

resource-version for concurrency

+

Name that identifies the physical interface

querypath string @@ -57488,6 +49653,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -57495,7 +49683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57510,17 +49698,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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/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

@@ -57529,13 +49717,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

p-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

@@ -57584,12 +49772,85 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing p-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing p-interface

+ +
+
+ +

application/json application/xml +

+
+
+

p-interface object that needs to be updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - + - - - - - - - - - - - - - - - - - - - - - + +
- interface-name + hostname -

Name given to the interface

+

Value from executing hostname on the compute node.

path @@ -57602,10 +49863,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 @@ -57632,7 +49893,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57647,17 +49908,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}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/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

@@ -57711,28 +49972,12 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address + resource-version -

IP address

+

resource-version for concurrency

pathquery string @@ -57757,7 +50002,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -57772,17 +50017,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}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l-interfaces
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces

Tags: CloudInfrastructure
-

returns l3-interface-ipv6-address-list

+

returns l-interfaces

@@ -57834,39 +50079,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 - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -57878,10 +50090,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id + interface-id -

ID of Pserver

query @@ -57893,24 +50104,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- pserver-name2 + macaddr -

alternative pserver name

query @@ -57922,10 +50118,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + network-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -57935,94 +50130,275 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l-interface
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

returns l-interface

+ +
+
+ + + + + + + + + + + - + - + - + + +
- interface-id + hostname -

ID of interface

+

Value from executing hostname on the compute node.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the physical interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l-interface
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+

l-interface object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + - + @@ -58034,29 +50410,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -58064,7 +50417,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58079,17 +50432,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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
update an existing l-interface
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv6-address-list

+

update an existing l-interface

@@ -58098,13 +50451,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l-interface object that needs to be updated.

@@ -58169,12 +50522,89 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- vlan-id-inner + hostname -

Inner VLAN tag

+

Value from executing hostname on the compute node.

querypath - integer + string +
- neutron-network-id + interface-name -

Neutron network id of the interface that address belongs to

+

Name that identifies the physical interface

querypath string +
- neutron-subnet-id + interface-name -

Neutron id of subnet that address belongs to

+

Name given to the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
delete an existing l-interface
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}

+ Tags: + CloudInfrastructure +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ hostname + +

Value from executing hostname on the compute node.

+
path + string + + + +
- l3-interface-ipv6-address + interface-name -

IP address

+

Name that identifies the physical interface

path @@ -58185,6 +50615,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 + + + +
@@ -58201,7 +50663,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58216,36 +50678,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l3-interface-ipv4-address-list
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

update an existing l3-interface-ipv6-address-list

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
@@ -58308,7 +50753,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -58331,6 +50776,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -58338,7 +50806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58353,23 +50821,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}

+
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
-

delete an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv4-address-list

application/json application/xml

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

+

+
+ +
@@ -58433,7 +50913,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -58447,22 +50927,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -58479,7 +50943,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58494,17 +50958,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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -58513,13 +50977,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -58586,7 +51050,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -58616,7 +51080,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58631,17 +51095,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}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv4-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -58711,7 +51175,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -58725,6 +51189,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -58741,7 +51221,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58756,11 +51236,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
see node definition for valid relationships
-

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/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
@@ -58775,7 +51255,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv4AddressList.json)

@@ -58846,6 +51326,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -58862,7 +51358,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58877,11 +51373,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
delete an existing relationship
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/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
@@ -58955,6 +51451,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv4-address + +

IP address

+
path + string + + + +
@@ -58971,7 +51483,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -58986,17 +51498,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 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 sriov-vfs

+

returns l3-interface-ipv6-address-list

@@ -59061,121 +51573,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

-
query - string - - -
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint - - query - boolean - - -
- pserver-name2 - -

alternative pserver name

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name + l3-interface-ipv6-address -

Name of the network

+

IP address

querypath string +
@@ -59307,10 +51733,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -59321,183 +51747,141 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing l3-interface-ipv6-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv6-address-list object that needs to be updated.

+

+
+ +
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + - - - - - - - - + @@ -59509,29 +51893,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /sriov-vf -
-
-
- -
default @@ -59539,7 +51900,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -59554,35 +51915,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 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
-

create or update an existing sriov-vf

+

delete an existing l3-interface-ipv6-address-list

application/json application/xml

-
-
-

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

-

-
-
-
-
- /sriov-vf -
-
-
- 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 + hostname -

Name of the network

+

Value from executing hostname on the compute node.

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 that identifies the physical interface

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 given to the 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 + l3-interface-ipv6-address -

Neutron network id of the interface

+

IP address

querypath string +
@@ -59646,10 +51995,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -59660,6 +52009,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -59676,7 +52041,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -59691,17 +52056,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing sriov-vf
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+
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
-

update an existing sriov-vf

+

see node definition for valid relationships

@@ -59710,13 +52075,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceL3InterfaceIpv6AddressList.json)

@@ -59783,10 +52148,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -59813,7 +52178,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -59828,17 +52193,17 @@ 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}

+
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 sriov-vf

+

delete an existing relationship

@@ -59908,10 +52273,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pci-id + l3-interface-ipv6-address -

PCI ID used to identify the sriov-vf

+

IP address

path @@ -59922,22 +52287,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -59954,7 +52303,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -59969,11 +52318,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -59988,7 +52337,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterface.json)

@@ -60059,22 +52408,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 - - - -
@@ -60091,7 +52424,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -60106,11 +52439,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}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -60184,22 +52517,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 - - - -
@@ -60216,7 +52533,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -60231,17 +52548,17 @@ 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

+
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 vlans

+

returns sriov-vfs

@@ -60306,54 +52623,9 @@ 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 + pci-id -

alternative pserver name

query @@ -60365,10 +52637,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vf-vlan-filter -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -60380,10 +52651,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + vf-mac-filter -

ID of interface

query @@ -60395,14 +52665,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vf-vlan-strip -

MAC address for the interface

query - string + boolean @@ -60410,10 +52679,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + neutron-network-id -

Name of the network

query @@ -60449,7 +52717,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -60462,7 +52730,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -60477,17 +52745,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 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 vlan

+

returns sriov-vf

@@ -60552,10 +52820,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 @@ -60566,153 +52834,301 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /sriov-vf +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing sriov-vf
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + - + - + - - - - - - - - + - + + +
- inv-status + hostname -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Value from executing hostname on the compute node.

querypath string +
- pserver-id + interface-name -

ID of Pserver

+

Name that identifies the physical interface

querypath string +
- in-maint - - query - boolean - - -
- pserver-name2 + interface-name -

alternative pserver name

+

Name given to the interface

querypath string +
- prov-status + pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

PCI ID used to identify the sriov-vf

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing sriov-vf
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

update an existing sriov-vf

+ +
+
+ +

application/json application/xml +

+
+
+

sriov-vf object that needs to be updated.

+

+
+
+
+
+ /sriov-vf +
+
+
+
+
+ + + + + + + + + + + - + - + - + - - - - - - - - + @@ -60724,29 +53140,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- -
- /vlan -
-
-
- -
default @@ -60754,7 +53147,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -60769,35 +53162,23 @@ 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}

+
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
-

create or update an existing vlan

+

delete an existing sriov-vf

application/json application/xml

-
-
-

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

-

-
-
-
-
- /vlan -
-
-
- interface-id + hostname -

ID of interface

+

Value from executing hostname on the compute node.

querypath string +
- macaddr + interface-name -

MAC address for the interface

+

Name that identifies the physical interface

querypath string +
- network-name + interface-name -

Name of the network

+

Name given to the interface

querypath string +
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key + pci-id -

This indicates the customers VPN ID associated with this vlan

+

PCI ID used to identify the sriov-vf

querypath string +
@@ -60861,10 +53242,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 @@ -60875,6 +53256,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -60891,7 +53288,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -60906,17 +53303,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
update an existing vlan
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+
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
-

update an existing vlan

+

see node definition for valid relationships

@@ -60925,13 +53322,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceSriovVfsSriovVf.json)

@@ -60998,10 +53395,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 @@ -61028,7 +53425,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -61043,17 +53440,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 relationship
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Tags: CloudInfrastructure
-

delete an existing vlan

+

delete an existing relationship

@@ -61123,10 +53520,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 @@ -61137,22 +53534,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -61169,7 +53550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -61184,17 +53565,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+
returns vlans
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans

Tags: CloudInfrastructure
-

returns l3-interface-ipv4-address-list

+

returns vlans

@@ -61262,39 +53643,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 - - - -
- inv-status - -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

query @@ -61306,28 +53654,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-id - -

ID of Pserver

-
query - string - - -
- in-maint + vlan-id-inner query - boolean + integer @@ -61335,10 +53668,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- pserver-name2 + vpn-key -

alternative pserver name

query @@ -61348,139 +53680,307 @@ 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

+ +
+
+ + + + + + + + + + + - + - + - + - + + +
- 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 + vlan-interface -

Name of the network

+

String that identifies the interface

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ +
+ /vlan +
+
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vlan
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing vlan

+ +
+
+ +

application/json application/xml +

+
+
+

vlan object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

+
+
+
+
+ /vlan +
+
+
+
+
+ + + + + + + + + + + - - - - - - - - + - + - + - + @@ -61492,29 +53992,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -61522,7 +53999,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -61537,17 +54014,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}

+
update an existing vlan
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}

Tags: CloudInfrastructure
-

create or update an existing l3-interface-ipv4-address-list

+

update an existing vlan

@@ -61556,13 +54033,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

vlan object that needs to be updated.

@@ -61643,22 +54120,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 + hostname -

This indicates the customers VPN ID associated with this vlan

+

Value from executing hostname on the compute node.

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name that identifies the physical interface

querypath - integer + string +
- 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 + vlan-interface -

Neutron id of subnet that address belongs to

+

String that identifies the interface

querypath string +
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
@@ -61675,7 +54136,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -61690,35 +54151,23 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing l3-interface-ipv4-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/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 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
-

update an existing l3-interface-ipv4-address-list

+

delete an existing vlan

application/json application/xml

-
-
-

l3-interface-ipv4-address-list object that needs to be created or updated.

-

-
- -
@@ -61798,12 +54247,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 @@ -61828,7 +54277,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -61844,23 +54293,18 @@ 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}

+
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
-

delete an existing l3-interface-ipv4-address-list

+

returns l3-interface-ipv4-address-list

-
- -

application/json application/xml -

-
@@ -61953,14 +54397,174 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing l3-interface-ipv4-address-list
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + CloudInfrastructure +
+
+
+

create or update an existing l3-interface-ipv4-address-list

+ +
+
+ +

application/json application/xml +

+
+
+

l3-interface-ipv4-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+ +
+
+
+ + + + + + + + + + + - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
- resource-version + hostname -

resource-version for concurrency

+

Value from executing hostname on the compute node.

querypath + 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 @@ -61985,7 +54589,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -62000,17 +54604,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

+
update an existing l3-interface-ipv4-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing l3-interface-ipv4-address-list

@@ -62019,13 +54623,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -62138,7 +54742,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -62153,17 +54757,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 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 relationship

+

delete an existing l3-interface-ipv4-address-list

@@ -62263,6 +54867,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -62279,7 +54899,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -62294,19 +54914,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}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
see node definition for valid relationships
+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/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
-

returns l3-interface-ipv6-address-list

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv4AddressList.json)

+

+
+
+
+ +
+
+
@@ -62385,7 +55022,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -62399,200 +55036,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 - - -
- 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 - - -
@@ -62602,29 +55045,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
default @@ -62632,7 +55052,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -62647,35 +55067,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}/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}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

-

-
- -
@@ -62755,7 +55163,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
- l3-interface-ipv6-address + l3-interface-ipv4-address

IP address

@@ -62785,7 +55193,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -62801,35 +55209,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
update an existing l3-interface-ipv6-address-list
-

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
returns l3-interface-ipv6-address-list
+

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
-

update an existing l3-interface-ipv6-address-list

+

returns l3-interface-ipv6-address-list

-
- -

application/json application/xml -

-
-
-

l3-interface-ipv6-address-list object that needs to be created or updated.

-

-
- -
-
@@ -62931,6 +55322,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
default @@ -62938,7 +55352,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -62954,22 +55368,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
delete an existing l3-interface-ipv6-address-list
-

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

+
create or update an existing l3-interface-ipv6-address-list
+

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
-

delete an existing l3-interface-ipv6-address-list

+

create or update an existing l3-interface-ipv6-address-list

application/json application/xml

+
+
+

l3-interface-ipv6-address-list object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

+
+ +
@@ -63063,22 +55489,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -63095,7 +55505,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63110,17 +55520,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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
update an existing l3-interface-ipv6-address-list
+

PATCH /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

see node definition for valid relationships

+

update an existing l3-interface-ipv6-address-list

@@ -63129,13 +55539,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. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -63248,7 +55658,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63263,17 +55673,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-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

+
delete an existing l3-interface-ipv6-address-list
+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

Tags: CloudInfrastructure
-

delete an existing relationship

+

delete an existing l3-interface-ipv6-address-list

@@ -63373,6 +55783,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -63389,7 +55815,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63404,11 +55830,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}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -63423,7 +55849,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlanL3InterfaceIpv6AddressList.json)

@@ -63510,6 +55936,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+ l3-interface-ipv6-address + +

IP address

+
path + string + + + +
@@ -63526,7 +55968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63541,11 +55983,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}/vlans/vlan/{vlan-interface}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -63635,6 +56077,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + l3-interface-ipv6-address + + +

IP address

+ + path + + string + + + + + + @@ -63651,7 +56109,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63666,11 +56124,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}/relationship-list/relationship

+

PUT /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -63685,7 +56143,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterfaceLInterfacesLInterfaceVlansVlan.json)

@@ -63740,6 +56198,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 + + + + + + + + + vlan-interface + + +

String that identifies the interface

+ + path + + string + + + + + + @@ -63756,7 +56246,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63771,11 +56261,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}/relationship-list/relationship

+

DELETE /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Tags: CloudInfrastructure
@@ -63833,6 +56323,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 + + + + + + + + + vlan-interface + + +

String that identifies the interface

+ + path + + string + + + + + + @@ -63849,7 +56371,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -63864,19 +56386,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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns sriov-pfs

+

see node definition for valid relationships

+
+ +

application/json application/xml +

+
+
+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/CloudInfrastructurePserversPserverPInterfacesPInterface.json)

+

+
+
+
+ +
+
+
@@ -63921,80 +56460,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 - - -
@@ -64004,29 +56469,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -64034,7 +56476,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64049,19 +56491,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 /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/relationship-list/relationship

Tags: CloudInfrastructure
-

returns sriov-pf

+

delete an existing relationship

+
+ +

application/json application/xml +

+
@@ -64106,12 +56553,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-pfs
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pfs

+ +
+
+ + + + + + + + + + + - + + +
- pf-pci-id + hostname -

Identifier for the sriov-pf

+

Value from executing hostname on the compute node.

path @@ -64124,25 +56627,25 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- inv-status + interface-name -

CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

+

Name that identifies the physical interface

querypath string +
- pserver-id + pf-pci-id -

ID of Pserver

query @@ -64152,48 +56655,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns sriov-pf
+

GET /cloud-infrastructure/pservers/pserver/{hostname}/p-interfaces/p-interface/{interface-name}/sriov-pfs/sriov-pf/{pf-pci-id}

+ Tags: + CloudInfrastructure +
+
+
+

returns sriov-pf

+ +
+
+ + + + + + + + + + + - + - + - + @@ -64235,7 +56821,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64356,7 +56942,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64390,7 +56976,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-pf object that needs to be created or updated.

+

sriov-pf object that needs to be updated.

@@ -64477,7 +57063,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64602,7 +57188,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64723,7 +57309,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64832,7 +57418,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64921,7 +57507,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -64998,7 +57584,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65026,6 +57612,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns virtual-data-centers

+
+
- 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 physical interface

querypath string +
- prov-status + pf-pci-id -

Trigger for operational monitoring of this resource by Service Assurance systems.

+

Identifier for the sriov-pf

querypath string +
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ vdc-id + + query + string + + +
+ vdc-name + + query + string + + +
+

application/json application/xml @@ -65062,7 +57691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65118,21 +57747,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vdc-name - - -

Name of the virtual data center

- - query - - string - - - - -
@@ -65172,7 +57786,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65261,7 +57875,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65295,7 +57909,7 @@ 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.

+

virtual-data-center object that needs to be updated.

@@ -65350,7 +57964,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65443,7 +58057,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65532,7 +58146,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65609,7 +58223,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65637,6 +58251,63 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns configurations

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ configuration-id + + query + string + + +
+ model-invariant-id + + query + string + + +
+ model-version-id + + query + string + + +
+

application/json application/xml @@ -65673,7 +58344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65729,36 +58400,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - -
@@ -65798,7 +58439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65887,7 +58528,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -65921,7 +58562,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

configuration object that needs to be created or updated.

+

configuration object that needs to be updated.

@@ -65976,7 +58617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66069,7 +58710,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66125,36 +58766,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - @@ -66194,7 +58805,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66266,36 +58877,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - @@ -66335,7 +58916,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66440,7 +59021,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66474,7 +59055,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

evc object that needs to be created or updated.

+

evc object that needs to be updated.

@@ -66545,7 +59126,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66654,7 +59235,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66759,7 +59340,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66852,7 +59433,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -66908,36 +59489,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - @@ -66977,7 +59528,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67049,36 +59600,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - @@ -67118,7 +59639,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67223,7 +59744,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67257,7 +59778,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

forwarder-evc object that needs to be created or updated.

+

forwarder-evc object that needs to be updated.

@@ -67328,7 +59849,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67437,7 +59958,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67542,7 +60063,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67635,7 +60156,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67693,25 +60214,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id + metaname -

the ASDC model version for this resource or service model.

query @@ -67760,7 +60265,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -67831,36 +60336,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - @@ -67900,7 +60375,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68004,7 +60479,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68038,7 +60513,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

metadatum object that needs to be created or updated.

+

metadatum object that needs to be updated.

@@ -68108,7 +60583,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68216,7 +60691,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68305,7 +60780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68382,7 +60857,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68410,6 +60885,49 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns forwarding-paths

+
+ + + + + + + + + + + + + + + + + + + + + + + + + + +
+ forwarding-path-id + + query + string + + +
+ forwarding-path-name + + query + string + + +
+

application/json application/xml @@ -68446,7 +60964,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68502,21 +61020,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - forwarding-path-name - - -

Name of the FP

- - query - - string - - - - -
@@ -68556,7 +61059,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68645,7 +61148,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68679,7 +61182,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

forwarding-path object that needs to be created or updated.

+

forwarding-path object that needs to be updated.

@@ -68734,7 +61237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68827,7 +61330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -68885,14 +61388,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - forwarding-path-name + sequence -

Name of the FP

query - string + integer @@ -68937,7 +61439,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69009,21 +61511,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - forwarding-path-name - - -

Name of the FP

- - query - - string - - - - - @@ -69063,7 +61550,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69168,7 +61655,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69202,7 +61689,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

forwarder object that needs to be created or updated.

+

forwarder object that needs to be updated.

@@ -69273,7 +61760,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69382,7 +61869,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69487,7 +61974,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69580,7 +62067,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69669,7 +62156,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69746,7 +62233,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -69773,70 +62260,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns generic-vnfs

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns generic-vnf
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}

- Tags: - Network -
-
-
-

returns generic-vnf

-
@@ -69855,15 +62278,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-id - + @@ -69871,7 +62292,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -75369,160 +66134,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
-

Unique id of VNF. This is unique across the graph.

pathquery string -
-

Name of VNF.

query @@ -69886,7 +62306,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen vnf-name2 -

Alternate name of VNF.

query @@ -69901,7 +62320,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen 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 @@ -69916,7 +62334,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

query @@ -69931,7 +62348,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen regional-resource-zone -

Regional way of organizing pservers, source of truth should define values

query @@ -69946,7 +62362,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen prov-status -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -69961,7 +62376,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

query @@ -70004,7 +62418,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id -

the ASDC model id for this resource or service model.

query @@ -70019,7 +62432,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

the ASDC model version for this resource or service model.

query @@ -70034,7 +62446,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -70049,7 +62460,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -70064,7 +62474,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-type -

Generic description of the type of NF

query @@ -70079,7 +62488,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-function -

English description of Network function that the specific VNF deployment is providing

query @@ -70094,7 +62502,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-role -

role in the network that this model will be providing

query @@ -70109,7 +62516,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen nf-naming-code -

string assigned to this model used for naming purposes

query @@ -70145,7 +62551,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -70158,7 +62564,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -70174,35 +62580,18 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing generic-vnf
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

+
returns generic-vnf
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

create or update an existing generic-vnf

+

returns generic-vnf

-
- -

application/json application/xml -

-
-
-

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)

-

-
-
-
- -
-
-
@@ -70240,6 +62629,29 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
default @@ -70247,7 +62659,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -70263,16 +62675,16 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
update an existing generic-vnf
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

+
create or update an existing generic-vnf
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

update an existing generic-vnf

+

create or update an existing generic-vnf

@@ -70281,13 +62693,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

generic-vnf object that needs to be created or updated.

+

generic-vnf object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnf.json)

@@ -70336,7 +62748,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -70352,22 +62764,34 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-
+
-
delete an existing generic-vnf
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

+
update an existing generic-vnf
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

delete an existing generic-vnf

+

update an existing generic-vnf

application/json application/xml

+
+
+

generic-vnf object that needs to be updated.

+

+
+
+
+ +
+
@@ -70397,22 +62821,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
@@ -70429,7 +62837,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -70444,19 +62852,24 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - -
+ +
-
returns entitlements
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

+
delete an existing generic-vnf
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

Tags: Network
-

returns entitlements

+

delete an existing generic-vnf

+
+ +

application/json application/xml +

+
@@ -70487,248 +62900,10 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -70747,308 +62923,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
- - - - - -
-
-
returns entitlement
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

- Tags: - Network -
-
-
-

returns entitlement

- -
-
-
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code + resource-version -

string assigned to this model used for naming purposes

+

resource-version for concurrency

query @@ -70736,6 +62911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen +
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
+

Response codes found in response codes.

+ +
+ +
+ +
+
+ +
+ + + + + + +
+
+
returns entitlements
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

+ Tags: + Network +
+
+
+

returns entitlements

+ +
+
+
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- group-uuid - -

Unique ID for the entitlement group the resource comes from, should be uuid.

-
path - string - - - -
- resource-uuid - -

Unique ID of an entitlement resource.

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
+ + + + + + + + + + - + + +
- widget-model-id + vnf-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- widget-model-version + group-uuid -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -71060,10 +63002,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-type + resource-uuid -

Generic description of the type of NF

query @@ -71073,49 +63014,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns entitlement
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}

+ Tags: + Network +
+
+
+

returns entitlement

+ +
+
+ + + + + + + + + + + - + - + - + @@ -71157,7 +63180,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -71278,7 +63301,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -71312,7 +63335,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

entitlement object that needs to be created or updated.

+

entitlement object that needs to be updated.

@@ -71399,7 +63422,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -71524,7 +63547,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -71645,7 +63668,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -71754,7 +63777,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -71812,203 +63835,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- nf-function + vnf-id -

English description of Network function that the specific VNF deployment is providing

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-role + group-uuid -

role in the network that this model will be providing

+

Unique ID for the entitlement group the resource comes from, should be uuid.

querypath string +
- nf-naming-code + resource-uuid -

string assigned to this model used for naming purposes

+

Unique ID of an entitlement resource.

querypath string +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type + interface-name -

Generic description of the type of NF

query @@ -72020,10 +63849,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-function + interface-id -

English description of Network function that the specific VNF deployment is providing

query @@ -72035,10 +63863,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + macaddr -

role in the network that this model will be providing

query @@ -72050,10 +63877,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + network-name -

string assigned to this model used for naming purposes

query @@ -72102,7 +63928,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -72174,304 +64000,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
@@ -72511,7 +64039,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -72616,7 +64144,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -72650,7 +64178,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -72721,116 +64249,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

- -
-
-
- -
-
- -
- - - - - - -
-
-
delete an existing l-interface
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

- Tags: - Network -
-
-
-

delete an existing l-interface

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- resource-version - -

resource-version for concurrency

-
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -72845,353 +64264,74 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
-
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
+
+
delete an existing l-interface
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}

+ Tags: + Network +
+
+
+

delete an existing l-interface

+ +
+
+ +

application/json application/xml +

+
+
+
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
+ + + + + + + + + + - + - + + +
- nf-naming-code + vnf-id -

string assigned to this model used for naming purposes

+

Unique id of VNF. This is unique across the graph.

querypath string +
- interface-id + interface-name -

ID of interface

+

Name given to the interface

querypath string +
- macaddr + resource-version -

MAC address for the interface

+

resource-version for concurrency

query @@ -73199,66 +64339,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 l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + - + - - - - - - - - + - + @@ -73300,7 +64485,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -73421,7 +64606,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -73455,7 +64640,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -73542,7 +64727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -73667,7 +64852,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -73788,7 +64973,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -73897,7 +65082,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -73985,349 +65170,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-name + vnf-id -

Name of the network

+

Unique id of VNF. This is unique across the graph.

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-ipv4-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -74367,7 +65209,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74488,7 +65330,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74522,7 +65364,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -74609,7 +65451,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74734,7 +65576,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74855,7 +65697,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -74964,7 +65806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75069,7 +65911,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75162,7 +66004,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75236,70 +66078,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone + pci-id -

Regional way of organizing pservers, source of truth should define values

query @@ -75311,10 +66092,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- prov-status + vf-vlan-filter -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -75326,10 +66106,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- heat-stack-id + vf-mac-filter -

Heat stack id corresponding to this instance, managed by MSO

query @@ -75341,21 +66120,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- in-maint - - query - boolean - - -
- is-closed-loop-disabled + vf-vlan-strip
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name + neutron-network-id -

Name of the network

query @@ -75571,7 +66185,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -75591,430 +66205,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
returns sriov-vf

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

- Tags: - Network -
-
-
-

returns sriov-vf

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + Tags: + Network + +
+
+

returns sriov-vf

+ +
+
+
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
+ + + + + + + + + + - + - + - - - - - - - - + @@ -76056,7 +66312,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76177,7 +66433,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76211,7 +66467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -76298,7 +66554,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76423,7 +66679,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76544,7 +66800,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76653,7 +66909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -76727,263 +66983,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vf-vlan-filter + vnf-id -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Unique id of VNF. This is unique across the graph.

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 given to the 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 + pci-id -

Neutron network id of the interface

+

PCI ID used to identify the sriov-vf

querypath string +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id + vlan-interface -

ID of interface

query @@ -76995,14 +66997,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

query - string + integer @@ -77010,10 +67011,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vpn-key -

Name of the network

query @@ -77062,7 +67062,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77150,334 +67150,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
@@ -77517,7 +67189,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77638,7 +67310,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77672,7 +67344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -77759,7 +67431,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -77861,504 +67533,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
query - string - - - -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-interface-ipv4-address-list
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

- Tags: - Network -
-
-
-

returns l3-interface-ipv4-address-list

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- vlan-interface - -

String that identifies the interface

-
path - string - - - -
- l3-interface-ipv4-address - -

IP address

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer + string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-interface-ipv4-address-list
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

+ Tags: + Network +
+
+
+

returns l3-interface-ipv4-address-list

+ +
+
+ + + + + + + + + + + - + - + - + - + @@ -78400,7 +67699,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -78537,7 +67836,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -78571,7 +67870,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -78674,7 +67973,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -78815,7 +68114,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -78952,7 +68251,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79077,7 +68376,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79181,379 +68480,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vpn-key + vnf-id -

This indicates the customers VPN ID associated with this vlan

+

Unique id of VNF. This is unique across the graph.

querypath string +
- vlan-id-inner + interface-name -

Inner VLAN tag

+

Name given to the interface

querypath - integer + string +
- neutron-network-id + vlan-interface -

Neutron network id of the interface that address belongs to

+

String that identifies the interface

querypath string +
- neutron-subnet-id + l3-interface-ipv4-address -

Neutron id of subnet that address belongs to

+

IP address

querypath string +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- neutron-network-id - -

Neutron network id of the interface that address belongs to

-
query - string - - -
- neutron-subnet-id - -

Neutron id of subnet that address belongs to

-
query - string - - -
@@ -79593,7 +68519,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79730,7 +68656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -79764,7 +68690,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -79867,7 +68793,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80008,7 +68934,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80145,7 +69071,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80270,7 +69196,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80391,7 +69317,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -80495,645 +69421,72 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
- -
-
- - -
-
-
returns lag-interfaces
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

- Tags: - Network -
-
-
-

returns lag-interfaces

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns lag-interface
-

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

- Tags: - Network -
-
-
-

returns lag-interface

- -
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + +
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+ + + + + + +
+
+
returns lag-interfaces
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

+ Tags: + Network +
+
+
+

returns lag-interfaces

+ +
+
+
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
+ + + + + + + + + + - + + +
- nf-type + vnf-id -

Generic description of the type of NF

+

Unique id of VNF. This is unique across the graph.

querypath string +
- nf-function + interface-name -

English description of Network function that the specific VNF deployment is providing

query @@ -81145,10 +69498,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-role + interface-id -

role in the network that this model will be providing

query @@ -81160,10 +69512,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + interface-role -

string assigned to this model used for naming purposes

query @@ -81173,34 +69524,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns lag-interface
+

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}

+ Tags: + Network +
+
+
+

returns lag-interface

+ +
+
+ + + + + + + + + + + - + - + @@ -81242,7 +69674,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81347,7 +69779,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81381,7 +69813,7 @@ 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.

+

lag-interface object that needs to be updated.

@@ -81452,7 +69884,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81561,7 +69993,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -81635,233 +70067,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- interface-id + vnf-id -

ID of interface

+

Unique id of VNF. This is unique across the graph.

querypath string +
- 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 +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role + interface-name -

role in the network that this model will be providing

query @@ -81873,10 +70081,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- nf-naming-code + interface-id -

string assigned to this model used for naming purposes

query @@ -81888,10 +70095,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-id + macaddr -

ID of interface

query @@ -81903,10 +70109,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- interface-role + network-name -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

query @@ -81955,7 +70160,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82043,334 +70248,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
@@ -82410,7 +70287,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82531,7 +70408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82565,7 +70442,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l-interface object that needs to be created or updated.

+

l-interface object that needs to be updated.

@@ -82652,7 +70529,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82777,7 +70654,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -82881,379 +70758,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

- - query - - string - - - - - - - - nf-naming-code - - -

string assigned to this model used for naming purposes

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -83293,7 +70797,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83430,7 +70934,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83464,7 +70968,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -83567,7 +71071,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83708,7 +71212,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83845,7 +71349,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -83970,7 +71474,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84074,379 +71578,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

- - query - - string - - - - - - - - nf-naming-code - - -

string assigned to this model used for naming purposes

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -84486,7 +71617,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84623,7 +71754,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84657,7 +71788,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -84760,7 +71891,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -84901,7 +72032,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85038,7 +72169,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85163,7 +72294,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85284,7 +72415,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85393,7 +72524,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85483,70 +72614,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone + pci-id -

Regional way of organizing pservers, source of truth should define values

query @@ -85558,10 +72628,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + vf-vlan-filter -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -85573,10 +72642,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - heat-stack-id + vf-mac-filter -

Heat stack id corresponding to this instance, managed by MSO

query @@ -85588,21 +72656,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled + vf-vlan-strip @@ -85616,190 +72670,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

- - query - - string - - - - - - - - nf-naming-code - - -

string assigned to this model used for naming purposes

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name + neutron-network-id -

Name of the network

query @@ -85848,7 +72721,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -85880,464 +72753,76 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + - + - + - + - + @@ -86379,7 +72864,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86516,7 +73001,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86550,7 +73035,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

sriov-vf object that needs to be created or updated.

+

sriov-vf object that needs to be updated.

@@ -86653,7 +73138,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86794,7 +73279,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -86931,7 +73416,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87056,7 +73541,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87146,293 +73631,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- vnf-id - -

Unique id of VNF. This is unique across the graph.

-
path - string - - - -
- interface-name - -

Name that identifies the link aggregate interface

-
path - string - - - -
- interface-name - -

Name given to the interface

-
path - string - - - -
- pci-id - -

PCI ID used to identify the sriov-vf

-
path - string - - - -
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vf-vlan-filter + vnf-id -

This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.

+

Unique id of VNF. This is unique across the graph.

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 + interface-name -

When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

+

Name given to the interface

querypath - boolean + string +
- neutron-network-id + pci-id -

Neutron network id of the interface

+

PCI ID used to identify the sriov-vf

querypath string +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id + vlan-interface -

ID of interface

query @@ -87444,14 +73645,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- macaddr + vlan-id-inner -

MAC address for the interface

query - string + integer @@ -87459,10 +73659,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name + vpn-key -

Name of the network

query @@ -87511,7 +73710,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -87615,364 +73814,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- interface-role - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

-
query - string - - -
- interface-id - -

ID of interface

-
query - string - - -
- macaddr - -

MAC address for the interface

-
query - string - - -
- network-name - -

Name of the network

-
query - string - - -
- vlan-id-inner - -

Inner VLAN tag

-
query - integer - - -
- vpn-key - -

This indicates the customers VPN ID associated with this vlan

-
query - string - - -
@@ -88012,7 +73853,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88149,7 +73990,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88183,7 +74024,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vlan object that needs to be created or updated.

+

vlan object that needs to be updated.

@@ -88286,7 +74127,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88427,7 +74268,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -88547,409 +74388,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

- - query - - string - - - - - - - - nf-naming-code - - -

string assigned to this model used for naming purposes

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - vpn-key - - -

This indicates the customers VPN ID associated with this vlan

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -88989,7 +74427,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89142,7 +74580,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89176,7 +74614,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv4-address-list object that needs to be created or updated.

+

l3-interface-ipv4-address-list object that needs to be updated.

@@ -89295,7 +74733,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89452,7 +74890,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89605,7 +75043,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89746,7 +75184,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -89866,409 +75304,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

- - query - - string - - - - - - - - nf-naming-code - - -

string assigned to this model used for naming purposes

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - interface-role - - -

Role assigned to this Interface, should use values as defined in ECOMP Yang models.

- - query - - string - - - - - - - - interface-id - - -

ID of interface

- - query - - string - - - - - - - - macaddr - - -

MAC address for the interface

- - query - - string - - - - - - - - network-name - - -

Name of the network

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - vpn-key - - -

This indicates the customers VPN ID associated with this vlan

- - query - - string - - - - - - - - vlan-id-inner - - -

Inner VLAN tag

- - query - - integer - - - - - - - - neutron-network-id - - -

Neutron network id of the interface that address belongs to

- - query - - string - - - - - - - - neutron-subnet-id - - -

Neutron id of subnet that address belongs to

- - query - - string - - - - - @@ -90308,7 +75343,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90461,7 +75496,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90495,7 +75530,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

l3-interface-ipv6-address-list object that needs to be created or updated.

+

l3-interface-ipv6-address-list object that needs to be updated.

@@ -90614,7 +75649,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90771,7 +75806,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -90924,7 +75959,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91065,7 +76100,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91202,7 +76237,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91327,7 +76362,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91432,7 +76467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91525,7 +76560,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91583,233 +76618,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role + group-uuid -

role in the network that this model will be providing

query @@ -91821,10 +76632,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - nf-naming-code + resource-uuid -

string assigned to this model used for naming purposes

query @@ -91873,7 +76683,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -91961,259 +76771,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone - - -

Regional way of organizing pservers, source of truth should define values

- - query - - string - - - - - - - - prov-status - - -

Trigger for operational monitoring of this resource by Service Assurance systems.

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - in-maint - - - - query - - boolean - - - - - - - - is-closed-loop-disabled - - - - query - - boolean - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

- - query - - string - - - - - - - - nf-naming-code - - -

string assigned to this model used for naming purposes

- - query - - string - - - - - @@ -92253,7 +76810,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92374,7 +76931,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92408,7 +76965,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

license object that needs to be created or updated.

+

license object that needs to be updated.

@@ -92495,7 +77052,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92620,7 +77177,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92741,7 +77298,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92850,7 +77407,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -92939,7 +77496,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93016,7 +77573,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93074,70 +77631,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - vnf-name - - -

Name of VNF.

- - query - - string - - - - - - - - vnf-name2 - - -

Alternate name of VNF.

- - query - - string - - - - - - - - vnf-type - - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - regional-resource-zone + vf-module-id -

Regional way of organizing pservers, source of truth should define values

query @@ -93149,10 +77645,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - prov-status + vf-module-name -

Trigger for operational monitoring of this resource by Service Assurance systems.

query @@ -93167,7 +77662,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

query @@ -93177,40 +77671,11 @@ 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 - - - - - model-invariant-id -

the ASDC model id for this resource or service model.

query @@ -93225,7 +77690,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

the ASDC model version for this resource or service model.

query @@ -93240,7 +77704,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -93255,52 +77718,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - - - - - nf-type - - -

Generic description of the type of NF

- - query - - string - - - - - - - - nf-function - - -

English description of Network function that the specific VNF deployment is providing

- - query - - string - - - - - - - - nf-role - - -

role in the network that this model will be providing

query @@ -93312,10 +77729,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - nf-naming-code + contrail-service-instance-fqdn -

string assigned to this model used for naming purposes

query @@ -93364,7 +77780,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93436,362 +77852,237 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
create or update an existing vf-module
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

create or update an existing vf-module

+ +
+
+ +

application/json application/xml +

+
+
+

vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + + +
- vnf-name - -

Name of VNF.

-
query - string - - -
- vnf-name2 - -

Alternate name of VNF.

-
query - string - - -
- vnf-type - -

String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

-
query - string - - -
- service-id - -

Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED

-
query - string - - -
- regional-resource-zone - -

Regional way of organizing pservers, source of truth should define values

-
query - string - - -
- prov-status - -

Trigger for operational monitoring of this resource by Service Assurance systems.

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- in-maint - - query - boolean - - -
- is-closed-loop-disabled - - query - boolean - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- nf-type - -

Generic description of the type of NF

-
query - string - - -
- nf-function - -

English description of Network function that the specific VNF deployment is providing

-
query - string - - -
- nf-role - -

role in the network that this model will be providing

-
query - string - - -
- nf-naming-code - -

string assigned to this model used for naming purposes

-
query - string - - -
- vf-module-name - -

Name of vf-module

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance.

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id + vnf-id -

the ASDC model version for this resource or service model.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- widget-model-id + vf-module-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

+

Unique ID of vf-module.

querypath string +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing vf-module
+

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+ Tags: + Network +
+
+
+

update an existing vf-module

+ +
+
+ +

application/json application/xml +

+
+
+

vf-module object that needs to be updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - + - + @@ -93803,29 +78094,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -93833,7 +78101,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93849,34 +78117,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing vf-module
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
delete an existing vf-module
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

Tags: Network
-

create or update an existing vf-module

+

delete an existing vf-module

application/json application/xml

-
-
-

vf-module object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

-

-
-
-
- -
-
- widget-model-version + vnf-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Unique id of VNF. This is unique across the graph.

querypath string +
- contrail-service-instance-fqdn + vf-module-id -

the Contrail unique ID for a service-instance

+

Unique ID of vf-module.

querypath string +
@@ -93922,6 +78178,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -93938,7 +78210,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -93953,17 +78225,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing vf-module
-

PATCH /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
see node definition for valid relationships
+

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network
-

update an existing vf-module

+

see node definition for valid relationships

@@ -93972,13 +78244,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

vf-module object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

@@ -94043,7 +78315,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94058,17 +78330,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing vf-module
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}

+
delete an existing relationship
+

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Tags: Network
-

delete an existing vf-module

+

delete an existing relationship

@@ -94120,22 +78392,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

resource-version for concurrency

- - query - - string - - - - - -
@@ -94152,7 +78408,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94167,36 +78423,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
see node definition for valid relationships
-

PUT /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

+
returns instance-groups
+

GET /network/instance-groups

Tags: Network
-

see node definition for valid relationships

+

returns instance-groups

-
- -

application/json application/xml -

-
-
-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkGenericVnfsGenericVnfVfModulesVfModule.json)

-

-
-
-
- -
-
-
@@ -94211,174 +78450,64 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - + - + - -
- vnf-id + id -

Unique id of VNF. This is unique across the graph.

pathquery string -
- vf-module-id + description -

Unique ID of vf-module.

pathquery string -
-
- -
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
delete an existing relationship
-

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - + - +
- vnf-id + type -

Unique id of VNF. This is unique across the graph.

pathquery string -
- vf-module-id + sub-type -

Unique ID of vf-module.

pathquery string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns instance-groups
-

GET /network/instance-groups

- Tags: - Network -
-
-
-

returns instance-groups

- -
-

application/json application/xml

@@ -94414,7 +78543,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94470,51 +78599,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - description - - -

Descriptive text to help identify the usage of this instance-group

- - query - - string - - - - - - - - type - - -

Only valid value today is lower case ha for high availability

- - query - - string - - - - - - - - sub-type - - -

Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

- - query - - string - - - - -
@@ -94554,7 +78638,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94643,7 +78727,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94677,7 +78761,7 @@ 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.

+

instance-group object that needs to be updated.

@@ -94732,7 +78816,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94825,7 +78909,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94914,7 +78998,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -94991,7 +79075,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95019,6 +79103,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns ipsec-configurations

+
+ + + + + + + + + + + + + + + + + + + +
+ ipsec-configuration-id + + query + string + + +
+

application/json application/xml @@ -95055,7 +79168,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95150,7 +79263,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95239,7 +79352,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95273,7 +79386,7 @@ 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.

+

ipsec-configuration object that needs to be updated.

@@ -95328,7 +79441,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95421,7 +79534,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95510,7 +79623,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95587,7 +79700,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95643,6 +79756,20 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + vig-address-type + + + + query + + string + + + + +
@@ -95682,7 +79809,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95793,7 +79920,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95898,7 +80025,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -95932,7 +80059,7 @@ 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.

+

vig-server object that needs to be updated.

@@ -96003,7 +80130,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96112,7 +80239,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96217,7 +80344,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96310,7 +80437,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96337,70 +80464,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns l3-networks

-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns l3-network
-

GET /network/l3-networks/l3-network/{network-id}

- Tags: - Network -
-
-
-

returns l3-network

-
@@ -96419,15 +80482,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-id - + @@ -96435,7 +80496,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-name
-

Network ID, should be uuid. Unique across A&AI.

pathquery string -
-

Name of the network, governed by some naming convention..

query @@ -96450,7 +80510,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen network-role -

Role the network plans - who defines these values?

query @@ -96465,7 +80524,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen service-id -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

query @@ -96480,7 +80538,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen heat-stack-id -

Heat stack id corresponding to this instance, managed by MSO

query @@ -96495,7 +80552,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen contrail-network-fqdn -

Contrail FQDN for the network

query @@ -96510,7 +80566,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-invariant-id -

the ASDC model id for this resource or service model.

query @@ -96525,7 +80580,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen model-version-id -

the ASDC model version for this resource or service model.

query @@ -96540,7 +80594,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -96555,7 +80608,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen widget-model-version -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -96569,6 +80621,101 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns l3-network
+

GET /network/l3-networks/l3-network/{network-id}

+ Tags: + Network +
+
+
+

returns l3-network

+ +
+
+ + + + + + + + + + + + + + + + + + + +
+ network-id + +

Network ID, should be uuid. Unique across A&AI.

+
path + string + + + +
+
+

application/json application/xml

@@ -96604,7 +80751,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96693,7 +80840,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96727,7 +80874,7 @@ 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.

+

l3-network object that needs to be updated.

@@ -96782,7 +80929,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96875,7 +81022,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -96933,134 +81080,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - network-name - - -

Name of the network, governed by some naming convention..

- - query - - string - - - - - - - - network-role - - -

Role the network plans - who defines these values?

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - contrail-network-fqdn - - -

Contrail FQDN for the network

- - query - - string - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version + vlan-id-inner -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query - string + integer @@ -97105,7 +81131,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97177,141 +81203,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - network-name - - -

Name of the network, governed by some naming convention..

- - query - - string - - - - - - - - network-role - - -

Role the network plans - who defines these values?

- - query - - string - - - - - - - - service-id - - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

- - query - - string - - - - - - - - heat-stack-id - - -

Heat stack id corresponding to this instance, managed by MSO

- - query - - string - - - - - - - - contrail-network-fqdn - - -

Contrail FQDN for the network

- - query - - string - - - - - - - - model-invariant-id - - -

the ASDC model id for this resource or service model.

- - query - - string - - - - - - - - model-version-id - - -

the ASDC model version for this resource or service model.

- - query - - string - - - - - - - - widget-model-id - - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

- - query - - string - - - - - - - - widget-model-version - - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

- - query - - string - - - - -
@@ -97351,7 +81242,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97456,7 +81347,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97490,7 +81381,7 @@ 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.

+

ctag-assignment object that needs to be updated.

@@ -97561,7 +81452,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97670,7 +81561,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97775,7 +81666,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97868,7 +81759,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -97957,7 +81848,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98034,7 +81925,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98061,236 +81952,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

returns segmentation-assignments

-
-
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- network-id - -

Network ID, should be uuid. Unique across A&AI.

-
path - string - - - -
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
-
- -
-

application/json application/xml -

- -
-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- - - -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - -
-
-
returns segmentation-assignment
-

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

- Tags: - Network -
-
-
-

returns segmentation-assignment

-
@@ -98325,113 +81986,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen segmentation-id - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
-

Route Table Reference id, UUID assigned to this instance.

-
path - string - - - -
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

query @@ -98441,34 +81995,115 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
+
+ +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ + + +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns segmentation-assignment
+

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

+ Tags: + Network +
+
+
+

returns segmentation-assignment

+ +
+
+ + + + + + + + + + + - + - + @@ -98510,7 +82145,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98615,7 +82250,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98649,7 +82284,7 @@ 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.

+

segmentation-assignment object that needs to be updated.

@@ -98720,7 +82355,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98829,7 +82464,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -98934,7 +82569,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99027,7 +82662,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99085,115 +82720,9 @@ 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 + segmentation-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Route Table Reference id, UUID assigned to this instance.

querypath string +
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id + subnet-id -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

query @@ -99205,10 +82734,9 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- widget-model-version + subnet-name -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

query @@ -99257,7 +82785,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99329,156 +82857,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- network-name - -

Name of the network, governed by some naming convention..

-
query - string - - -
- network-role - -

Role the network plans - who defines these values?

-
query - string - - -
- service-id - -

Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED

-
query - string - - -
- heat-stack-id - -

Heat stack id corresponding to this instance, managed by MSO

-
query - string - - -
- contrail-network-fqdn - -

Contrail FQDN for the network

-
query - string - - -
- model-invariant-id - -

the ASDC model id for this resource or service model.

-
query - string - - -
- model-version-id - -

the ASDC model version for this resource or service model.

-
query - string - - -
- widget-model-id - -

the ASDC data dictionary widget model. This maps directly to the A&AI widget.

-
query - string - - -
- widget-model-version - -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

-
query - string - - -
- subnet-name - -

Name associated with the subnet.

-
query - string - - -
@@ -99518,7 +82896,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99623,7 +83001,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99657,7 +83035,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

subnet object that needs to be created or updated.

+

subnet object that needs to be updated.

@@ -99728,7 +83106,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99837,7 +83215,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -99911,100 +83289,9 @@ 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 + host-route-id -

the ASDC model version for this resource or service model.

query @@ -100014,49 +83301,131 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + +
+

application/json application/xml +

+ +
+
+ 200 OK + +
+
+
+
+

successful operation

+ +
+
+
+ +
+
+ + +
+
+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
returns host-route
+

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+ Tags: + Network +
+
+
+

returns host-route

+ +
+
+ + + + + + + + + + + - + - + - + @@ -100085,7 +83454,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen @@ -100098,7 +83467,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100114,18 +83483,35 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
returns host-route
-

GET /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+
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 host-route

+

create or update an existing host-route

+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

+
+
+
+ +
+
+
- 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 + subnet-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Subnet ID, should be UUID.

querypath string +
- subnet-name + host-route-id -

Name associated with the subnet.

+

host-route id

querypath string +
@@ -100186,154 +83572,125 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + +
+
+ +
+

application/json application/xml +

+ +
+
+ default + +
+
+
+
+

Response codes found in response codes.

+ +
+
+
+ +
+
+ +
+
+
+
+
+ + +
+
+
update an existing host-route
+

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+ Tags: + Network +
+
+
+

update an existing host-route

+ +
+
+ +

application/json application/xml +

+
+
+

host-route object that needs to be updated.

+

+
+
+
+ +
+
+
+
+ + + + + + + + + + + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + - + - + @@ -100345,29 +83702,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-
- 200 OK - -
-
-
-
-

successful operation

- -
-
-
- -
-
- - -
-
- -
default @@ -100375,7 +83709,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100391,34 +83725,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen -
+
-
create or update an existing host-route
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+
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
-

create or update an existing host-route

+

delete an existing host-route

application/json application/xml

-
-
-

host-route object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

-

-
-
-
- -
-
- 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 + 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 + subnet-id -

the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

+

Subnet ID, should be UUID.

querypath string +
- subnet-name + host-route-id -

Name associated with the subnet.

+

host-route id

querypath string +
@@ -100480,6 +83802,22 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen + + + + + + +
+ resource-version + +

resource-version for concurrency

+
query + string + + + +
@@ -100496,7 +83834,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100511,17 +83849,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
update an existing host-route
-

PATCH /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-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
-

update an existing host-route

+

see node definition for valid relationships

@@ -100530,13 +83868,13 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

host-route object that needs to be created or updated.

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

@@ -100617,7 +83955,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100632,17 +83970,17 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
-
delete an existing host-route
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}

+
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 host-route

+

delete an existing relationship

@@ -100710,22 +84048,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - resource-version - - -

resource-version for concurrency

- - query - - string - - - - - -
@@ -100742,7 +84064,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100757,11 +84079,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
see node definition for valid relationships
-

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

+

PUT /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network
@@ -100776,7 +84098,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen

-

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnetHostRoutesHostRoute.json)

+

relationship object that needs to be created or updated. [Valid relationship examples shown here](apidocs/relations/v12/NetworkL3NetworksL3NetworkSubnetsSubnet.json)

@@ -100831,22 +84153,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - host-route-id - - -

host-route id

- - path - - string - - - - - - @@ -100863,7 +84169,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100878,11 +84184,11 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ +
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/host-routes/host-route/{host-route-id}/relationship-list/relationship

+

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Tags: Network
@@ -100940,22 +84246,6 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen - - - host-route-id - - -

host-route id

- - path - - string - - - - - - @@ -100972,7 +84262,7 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
-

Response codes found in response codes.

+

Response codes found in response codes.

@@ -100987,36 +84277,19 @@ This document is best viewed with Firefox or Chrome. Nodes can be found by appen
- -
+ + - - -
-
-
delete an existing relationship
-

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

- Tags: - Network -
-
-
-

delete an existing relationship

- -
-
- -

application/json application/xml -

-
-
- - - - - - - - - - - - - - - - - - - - - +
- network-id - -

Network ID, should be uuid. Unique across A&AI.

-
path - string - - - -
- subnet-id + link-name -

Subnet ID, should be UUID.

pathquery string -
-
-

application/json application/xml -

- -
-
- default - -
-
-
-
-

Response codes found in response codes.

- -
-
-
- -
-
- -
-
-
-
-
- - - - - - - -