Active and Available Inventory REST API v11

Description

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

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

You may obtain a copy of the License at

(https://creativecommons.org/licenses/by/4.0/)

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

ECOMP and OpenECOMP are trademarks and service marks of AT&T Intellectual Property.

This document is best viewed with Firefox or Chrome. Nodes can be found by appending /#/definitions/node-type-to-find to the path to this document. Edge definitions can be found with the node definitions.

Contact Information

None

None

None

License

Apache 2.0

Base URL

https://None/aai/v11

BUSINESS

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

Summary

create or update an existing connector

Description

create or update an existing connector

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing metadatum

Description

create or update an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.
metaname path Yes string      

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing customer

Description

create or update an existing customer

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 307); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing service-subscription

Description

create or update an existing service-subscription

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 415); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing service-instance

Description

create or update an existing service-instance

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing allotted-resource

Description

create or update an existing allotted-resource

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 585); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing tunnel-xconnect

Description

create or update an existing tunnel-xconnect

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
id path Yes string     Allotted Resource id UUID assigned to this instance.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
id path Yes string     Allotted Resource id UUID assigned to this instance.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 699); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing metadatum

Description

create or update an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
metaname path Yes string      

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 758); backlink

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 810); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing line-of-business

Description

create or update an existing line-of-business

Parameters

Name Located in Required Type Format Properties Description
line-of-business-name path Yes string     Name of the line-of-business (product)

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
line-of-business-name path Yes string     Name of the line-of-business (product)

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 916); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing owning-entity

Description

create or update an existing owning-entity

Parameters

Name Located in Required Type Format Properties Description
owning-entity-id path Yes string     UUID of an owning entity

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
owning-entity-id path Yes string     UUID of an owning entity

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 1022); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing platform

Description

create or update an existing platform

Parameters

Name Located in Required Type Format Properties Description
platform-name path Yes string     Name of the platform

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
platform-name path Yes string     Name of the platform

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 1128); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing project

Description

create or update an existing project

Parameters

Name Located in Required Type Format Properties Description
project-name path Yes string     Name of the project deploying a service

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
project-name path Yes string     Name of the project deploying a service

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 1234); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing connector

Description

delete an existing connector

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing metadatum

Description

delete an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.
metaname path Yes string      
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing customer

Description

delete an existing customer

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing service-subscription

Description

delete an existing service-subscription

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing service-instance

Description

delete an existing service-instance

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing allotted-resource

Description

delete an existing allotted-resource

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing tunnel-xconnect

Description

delete an existing tunnel-xconnect

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
id path Yes string     Allotted Resource id UUID assigned to this instance.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
id path Yes string     Allotted Resource id UUID assigned to this instance.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing metadatum

Description

delete an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
metaname path Yes string      
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing line-of-business

Description

delete an existing line-of-business

Parameters

Name Located in Required Type Format Properties Description
line-of-business-name path Yes string     Name of the line-of-business (product)
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
line-of-business-name path Yes string     Name of the line-of-business (product)

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing owning-entity

Description

delete an existing owning-entity

Parameters

Name Located in Required Type Format Properties Description
owning-entity-id path Yes string     UUID of an owning entity
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
owning-entity-id path Yes string     UUID of an owning entity

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing platform

Description

delete an existing platform

Parameters

Name Located in Required Type Format Properties Description
platform-name path Yes string     Name of the platform
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
platform-name path Yes string     Name of the platform

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing project

Description

delete an existing project

Parameters

Name Located in Required Type Format Properties Description
project-name path Yes string     Name of the project deploying a service
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
project-name path Yes string     Name of the project deploying a service

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /business/connectors

Summary

returns connectors

Description

returns connectors

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns connector

Description

returns connector

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 2359); backlink

Duplicate explicit target name: "i_dc3b96be71def44ce61f5197b9e0d9a9".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns metadata

Description

returns metadata

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns metadatum

Description

returns metadatum

Parameters

Name Located in Required Type Format Properties Description
resource-instance-id path Yes string     Unique id of resource instance.
metaname path Yes string      
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 2494); backlink

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /business/customers

Summary

returns customers

Description

returns customers

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns customer

Description

returns customer

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 2612); backlink

Duplicate explicit target name: "i_fce907b082d29cb942cbdd1e9fd68abf".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns service-subscriptions

Description

returns service-subscriptions

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns service-subscription

Description

returns service-subscription

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 2743); backlink

Duplicate explicit target name: "i_dd892e6b73902e5e959a9b8fc37a8ed3".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns service-instances

Description

returns service-instances

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns service-instance

Description

returns service-instance

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 2885); backlink

Duplicate explicit target name: "i_56b73ff5fbd128ad31d4451e0c795541".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns allotted-resources

Description

returns allotted-resources

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns allotted-resource

Description

returns allotted-resource

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
type query No string     Generic description of the type of allotted resource.
role query No string     role in the network that this resource will be providing.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3042); backlink

Duplicate explicit target name: "i_525457a1212e4a768697d3941f0768b7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns tunnel-xconnects

Description

returns tunnel-xconnects

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
type query No string     Generic description of the type of allotted resource.
role query No string     role in the network that this resource will be providing.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns tunnel-xconnect

Description

returns tunnel-xconnect

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
id path Yes string     Allotted Resource id UUID assigned to this instance.
id path Yes string     Allotted Resource id UUID assigned to this instance.
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
type query No string     Generic description of the type of allotted resource.
role query No string     role in the network that this resource will be providing.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3205); backlink

Duplicate explicit target name: "i_2ebe2510685b62f9169f78f937be32d6".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns metadata

Description

returns metadata

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3281); backlink

Duplicate explicit target name: "i_c1c8a58aeed68efb121284a09febd9c2".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns metadatum

Description

returns metadatum

Parameters

Name Located in Required Type Format Properties Description
global-customer-id path Yes string     Global customer id used across ECOMP to uniquely identify customer.
service-type path Yes string     Value defined by orchestration to identify this service across ECOMP.
service-instance-id path Yes string     Uniquely identifies this instance of a service
metaname path Yes string      
subscriber-name query No string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type query No string     Subscriber type, a way to provide VID with only the INFRA customers.
service-instance-name query No string     This field will store a name assigned to the service-instance.
environment-context query No string     This field will store the environment context assigned to the service-instance.
workload-context query No string     This field will store the workload context assigned to the service-instance.
model-invariant-id query No string     the ASDC model id for this resource or service model.
model-version-id query No string     the ASDC model version for this resource or service model.
widget-model-id query No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version query No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
service-instance-location-id query No string     An identifier that customers assign to the location where this service is being used.
orchestration-status query No string     Orchestration status of this service.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3358); backlink

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /business/lines-of-business

Summary

returns lines-of-business

Description

returns lines-of-business

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns line-of-business

Description

returns line-of-business

Parameters

Name Located in Required Type Format Properties Description
line-of-business-name path Yes string     Name of the line-of-business (product)

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3474); backlink

Duplicate explicit target name: "i_4c9a2ed440bf1a52cb5c6f554b57c866".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /business/owning-entities

Summary

returns owning-entities

Description

returns owning-entities

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns owning-entity

Description

returns owning-entity

Parameters

Name Located in Required Type Format Properties Description
owning-entity-id path Yes string     UUID of an owning entity

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3590); backlink

Duplicate explicit target name: "i_2d49ced111ed3ef9a5e3f7d84059b8e2".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /business/platforms

Summary

returns platforms

Description

returns platforms

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns platform

Description

returns platform

Parameters

Name Located in Required Type Format Properties Description
platform-name path Yes string     Name of the platform

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3706); backlink

Duplicate explicit target name: "i_bbf1456f16dc4f9e3f0edfb0db178ae4".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /business/projects

Summary

returns projects

Description

returns projects

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns project

Description

returns project

Parameters

Name Located in Required Type Format Properties Description
project-name path Yes string     Name of the project deploying a service

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 3822); backlink

Duplicate explicit target name: "i_eccf78fe69afe99ba1b502bbdeacced3".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

CLOUDINFRASTRUCTURE

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

Summary

create or update an existing cloud-region

Description

create or update an existing cloud-region

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing availability-zone

Description

create or update an existing availability-zone

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
availability-zone-name path Yes string     Name of the availability zone. Unique across a cloud region

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
availability-zone-name path Yes string     Name of the availability zone. Unique across a cloud region

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 3993); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing dvs-switch

Description

create or update an existing dvs-switch

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
switch-name path Yes string     DVS switch name

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
switch-name path Yes string     DVS switch name

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4103); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing esr-system-info

Description

create or update an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4213); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing flavor

Description

create or update an existing flavor

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
flavor-id path Yes string     Flavor id, expected to be unique across cloud-region.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
flavor-id path Yes string     Flavor id, expected to be unique across cloud-region.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4323); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing group-assignment

Description

create or update an existing group-assignment

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
group-id path Yes string     Group id, expected to be unique across cloud-region.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
group-id path Yes string     Group id, expected to be unique across cloud-region.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4433); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing image

Description

create or update an existing image

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing metadatum

Description

create or update an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region
metaname path Yes string      

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4550); backlink

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4602); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing oam-network

Description

create or update an existing oam-network

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
network-uuid path Yes string     UUID of the network. Unique across a cloud-region

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
network-uuid path Yes string     UUID of the network. Unique across a cloud-region

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4712); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4763); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing snapshot

Description

create or update an existing snapshot

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
snapshot-id path Yes string     Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
snapshot-id path Yes string     Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4873); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing tenant

Description

create or update an existing tenant

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 4983); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vserver

Description

create or update an existing vserver

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

create or update an existing l-interface

Description

create or update an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5218); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5334); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5388); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

create or update an existing sriov-vf

Description

create or update an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5504); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

create or update an existing vlan

Description

create or update an existing vlan

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5627); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5683); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5745); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5801); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5856); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 5909); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing volume

Description

create or update an existing volume

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
volume-id path Yes string     Unique ID of block storage volume relative to the vserver.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
volume-id path Yes string     Unique ID of block storage volume relative to the vserver.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6023); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv4-address path Yes string     IP address

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6133); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv6-address path Yes string     IP address

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6243); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing volume-group

Description

create or update an existing volume-group

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
volume-group-id path Yes string     Unique ID of volume-group.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
volume-group-id path Yes string     Unique ID of volume-group.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6353); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing complex

Description

create or update an existing complex

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing ctag-pool

Description

create or update an existing ctag-pool

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
target-pe path Yes string     The Target provider edge router
availability-zone-name path Yes string     Name of the availability zone

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
target-pe path Yes string     The Target provider edge router
availability-zone-name path Yes string     Name of the availability zone

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6519); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6569); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing network-profile

Description

create or update an existing network-profile

Parameters

Name Located in Required Type Format Properties Description
nm-profile-name path Yes string     Unique name of network profile.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
nm-profile-name path Yes string     Unique name of network profile.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6675); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing pserver

Description

create or update an existing pserver

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing lag-interface

Description

create or update an existing lag-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing l-interface

Description

create or update an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6846); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6905); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 6958); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7017); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7070); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7122); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing sriov-vf

Description

create or update an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7181); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7234); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vlan

Description

create or update an existing vlan

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7293); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7353); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7407); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7467); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7521); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7574); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7625); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing p-interface

Description

create or update an existing p-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing l-interface

Description

create or update an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7740); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7799); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7852); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7911); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 7964); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8016); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing sriov-vf

Description

create or update an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8075); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8128); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vlan

Description

create or update an existing vlan

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8187); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8247); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8301); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8361); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8415); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8468); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8519); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing sriov-pf

Description

create or update an existing sriov-pf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
pf-pci-id path Yes string     Identifier for the sriov-pf

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
pf-pci-id path Yes string     Identifier for the sriov-pf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8629); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8679); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing virtual-data-center

Description

create or update an existing virtual-data-center

Parameters

Name Located in Required Type Format Properties Description
vdc-id path Yes string     Unique ID of the vdc

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vdc-id path Yes string     Unique ID of the vdc

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 8785); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing cloud-region

Description

delete an existing cloud-region

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing availability-zone

Description

delete an existing availability-zone

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
availability-zone-name path Yes string     Name of the availability zone. Unique across a cloud region
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
availability-zone-name path Yes string     Name of the availability zone. Unique across a cloud region

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing dvs-switch

Description

delete an existing dvs-switch

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
switch-name path Yes string     DVS switch name
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
switch-name path Yes string     DVS switch name

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-system-info

Description

delete an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
esr-system-info-id path Yes string     Unique ID of esr system info.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing flavor

Description

delete an existing flavor

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
flavor-id path Yes string     Flavor id, expected to be unique across cloud-region.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
flavor-id path Yes string     Flavor id, expected to be unique across cloud-region.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing group-assignment

Description

delete an existing group-assignment

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
group-id path Yes string     Group id, expected to be unique across cloud-region.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
group-id path Yes string     Group id, expected to be unique across cloud-region.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing image

Description

delete an existing image

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing metadatum

Description

delete an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region
metaname path Yes string      
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing oam-network

Description

delete an existing oam-network

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
network-uuid path Yes string     UUID of the network. Unique across a cloud-region
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
network-uuid path Yes string     UUID of the network. Unique across a cloud-region

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing snapshot

Description

delete an existing snapshot

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
snapshot-id path Yes string     Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
snapshot-id path Yes string     Snapshot id, this is the key UUID assoc associated in glance with the snapshots.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing tenant

Description

delete an existing tenant

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing vserver

Description

delete an existing vserver

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

delete an existing l-interface

Description

delete an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

delete an existing sriov-vf

Description

delete an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

delete an existing vlan

Description

delete an existing vlan

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing volume

Description

delete an existing volume

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
volume-id path Yes string     Unique ID of block storage volume relative to the vserver.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
volume-id path Yes string     Unique ID of block storage volume relative to the vserver.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing vip-ipv4-address-list

Description

delete an existing vip-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing vip-ipv6-address-list

Description

delete an existing vip-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing volume-group

Description

delete an existing volume-group

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
volume-group-id path Yes string     Unique ID of volume-group.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
volume-group-id path Yes string     Unique ID of volume-group.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing complex

Description

delete an existing complex

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing ctag-pool

Description

delete an existing ctag-pool

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
target-pe path Yes string     The Target provider edge router
availability-zone-name path Yes string     Name of the availability zone
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
target-pe path Yes string     The Target provider edge router
availability-zone-name path Yes string     Name of the availability zone

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing network-profile

Description

delete an existing network-profile

Parameters

Name Located in Required Type Format Properties Description
nm-profile-name path Yes string     Unique name of network profile.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
nm-profile-name path Yes string     Unique name of network profile.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing pserver

Description

delete an existing pserver

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing lag-interface

Description

delete an existing lag-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing l-interface

Description

delete an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing sriov-vf

Description

delete an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing vlan

Description

delete an existing vlan

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing p-interface

Description

delete an existing p-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing l-interface

Description

delete an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing sriov-vf

Description

delete an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing vlan

Description

delete an existing vlan

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing sriov-pf

Description

delete an existing sriov-pf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
pf-pci-id path Yes string     Identifier for the sriov-pf
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
pf-pci-id path Yes string     Identifier for the sriov-pf

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing virtual-data-center

Description

delete an existing virtual-data-center

Parameters

Name Located in Required Type Format Properties Description
vdc-id path Yes string     Unique ID of the vdc
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vdc-id path Yes string     Unique ID of the vdc

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /cloud-infrastructure/cloud-regions

Summary

returns cloud-regions

Description

returns cloud-regions

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns cloud-region

Description

returns cloud-region

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13105); backlink

Duplicate explicit target name: "i_6734175ee148fd23afbc840cc3ae1365".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns availability-zones

Description

returns availability-zones

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns availability-zone

Description

returns availability-zone

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
availability-zone-name path Yes string     Name of the availability zone. Unique across a cloud region
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13238); backlink

Duplicate explicit target name: "i_b42d7482046b4d4973a9d394b5902058".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns dvs-switches

Description

returns dvs-switches

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns dvs-switch

Description

returns dvs-switch

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
switch-name path Yes string     DVS switch name
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
vcenter-url query No string     URL used to reach the vcenter

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13372); backlink

Duplicate explicit target name: "i_20b6ce1bb4c6db9e7b571ea785fad8bc".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info-list

Description

returns esr-system-info-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info

Description

returns esr-system-info

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
esr-system-info-id path Yes string     Unique ID of esr system info.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
system-name query No string     name of external system.
system-type query No string     it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13507); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns flavors

Description

returns flavors

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns flavor

Description

returns flavor

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
flavor-id path Yes string     Flavor id, expected to be unique across cloud-region.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
flavor-name query No string     Flavor name

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13641); backlink

Duplicate explicit target name: "i_571f5e6060c4735fc4a3a8405ac27d0d".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns group-assignments

Description

returns group-assignments

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns group-assignment

Description

returns group-assignment

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
group-id path Yes string     Group id, expected to be unique across cloud-region.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
group-type query No string     Group type - the type of group this instance refers to
group-name query No string     Group name - name assigned to the group

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13776); backlink

Duplicate explicit target name: "i_f6c140e75861964f717c02c75fb09721".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns images

Description

returns images

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns image

Description

returns image

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
image-name query No string     Image name
application query No string     The application that the image instantiates.
application-vendor query No string     The vendor of the application.
application-version query No string     The version of the application.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13913); backlink

Duplicate explicit target name: "i_a51c24325979e69e4cfe99e2a92eae43".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns metadata

Description

returns metadata

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
image-name query No string     Image name
application query No string     The application that the image instantiates.
application-vendor query No string     The vendor of the application.
application-version query No string     The version of the application.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 13984); backlink

Duplicate explicit target name: "i_c1c8a58aeed68efb121284a09febd9c2".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns metadatum

Description

returns metadatum

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
image-id path Yes string     Image id, expected to be unique across cloud region
metaname path Yes string      
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
image-name query No string     Image name
application query No string     The application that the image instantiates.
application-vendor query No string     The vendor of the application.
application-version query No string     The version of the application.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14056); backlink

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns oam-networks

Description

returns oam-networks

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns oam-network

Description

returns oam-network

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
network-uuid path Yes string     UUID of the network. Unique across a cloud-region
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
network-name query No string     Name of the network.
cvlan-tag query No integer int64   cvlan-id

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14191); backlink

Duplicate explicit target name: "i_1e18de35af33a443b1075762d99f74ca".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns snapshots

Description

returns snapshots

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns snapshot

Description

returns snapshot

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
snapshot-id path Yes string     Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
snapshot-name query No string     Snapshot name
application query No string     The application that the image instantiates.
application-vendor query No string     The vendor of the application.
application-version query No string     The version of the application.
prev-snapshot-id query No string     This field contains the UUID of the previous snapshot (if any).

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14329); backlink

Duplicate explicit target name: "i_f766386b482511567bb8cf26fce6a7e7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns tenants

Description

returns tenants

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns tenant

Description

returns tenant

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14464); backlink

Duplicate explicit target name: "i_f330302f0065d2bdb215cc9170d4091e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vservers

Description

returns vservers

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vserver

Description

returns vserver

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14608); backlink

Duplicate explicit target name: "i_dfa0cd5f7fd23be6afa43c24fc92fbf7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns l-interfaces

Description

returns l-interfaces

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l-interface

Description

returns l-interface

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14762); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14845); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 14928); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-vfs

Description

returns sriov-vfs

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns sriov-vf

Description

returns sriov-vf

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vf-vlan-filter query No string     This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
vf-mac-filter query No string     When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
vf-vlan-strip query No boolean     When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
neutron-network-id query No string     Neutron network id of the interface

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15091); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vlans

Description

returns vlans

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns vlan

Description

returns vlan

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15252); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15338); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15424); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns volumes

Description

returns volumes

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns volume

Description

returns volume

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
tenant-id path Yes string     Unique id relative to the cloud-region.
vserver-id path Yes string     Unique identifier for this vserver relative to its tenant
volume-id path Yes string     Unique ID of block storage volume relative to the vserver.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
tenant-name query No string     Readable name of tenant
tenant-context query No string     This field will store the tenant context.
vserver-name query No string     Name of vserver
vserver-name2 query No string     Alternative name of vserver
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
in-maint query No boolean      
is-closed-loop-disabled query No boolean      

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15575); backlink

Duplicate explicit target name: "i_bc1fedb416ba33484ad0ebb947967501".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vip-ipv4-address-list

Description

returns vip-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv4-address path Yes string     IP address
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15645); backlink

Duplicate explicit target name: "i_c642e7ae284cb2ffe94c3d2028fc0835".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vip-ipv6-address-list

Description

returns vip-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
vip-ipv6-address path Yes string     IP address
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15715); backlink

Duplicate explicit target name: "i_e3de5be9093341a784feaac64508a2a4".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns volume-groups

Description

returns volume-groups

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns volume-group

Description

returns volume-group

Parameters

Name Located in Required Type Format Properties Description
cloud-owner path Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id path Yes string     Identifier used by the vendor for the region. Second part of composite key
volume-group-id path Yes string     Unique ID of volume-group.
cloud-type query No string     Type of the cloud (e.g., openstack)
owner-defined-type query No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
volume-group-name query No string     Name of the volume group.
heat-stack-id query No string     Heat stack id corresponding to this volume-group
vnf-type query No string     String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15851); backlink

Duplicate explicit target name: "i_9d66516837e3c652ee9f0a21a5bd748e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /cloud-infrastructure/complexes

Summary

returns complexes

Description

returns complexes

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns complex

Description

returns complex

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
data-center-code query No string     Data center code which can be an alternate way to identify a complex
complex-name query No string     Gamma complex name for LCP instance.
identity-url query No string     URL of the keystone identity service

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 15970); backlink

Duplicate explicit target name: "i_b886c673cb6f4cb1994b52b0959747fd".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns ctag-pools

Description

returns ctag-pools

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
data-center-code query No string     Data center code which can be an alternate way to identify a complex
complex-name query No string     Gamma complex name for LCP instance.
identity-url query No string     URL of the keystone identity service

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns ctag-pool

Description

returns ctag-pool

Parameters

Name Located in Required Type Format Properties Description
physical-location-id path Yes string     Unique identifier for physical location, e.g., CLLI
target-pe path Yes string     The Target provider edge router
availability-zone-name path Yes string     Name of the availability zone
data-center-code query No string     Data center code which can be an alternate way to identify a complex
complex-name query No string     Gamma complex name for LCP instance.
identity-url query No string     URL of the keystone identity service

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16104); backlink

Duplicate explicit target name: "i_61de10ec6864ae7434ce7296170afd37".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /cloud-infrastructure/network-profiles

Summary

returns network-profiles

Description

returns network-profiles

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns network-profile

Description

returns network-profile

Parameters

Name Located in Required Type Format Properties Description
nm-profile-name path Yes string     Unique name of network profile.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16220); backlink

Duplicate explicit target name: "i_a50e1b79cd43e4089afc53d6a882521a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /cloud-infrastructure/pservers

Summary

returns pservers

Description

returns pservers

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns pserver

Description

returns pserver

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16340); backlink

Duplicate explicit target name: "i_52218c7dbc286864a4a5e4cdc72d4f10".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns lag-interfaces

Description

returns lag-interfaces

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns lag-interface

Description

returns lag-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16477); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns l-interfaces

Description

returns l-interfaces

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16547); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns l-interface

Description

returns l-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16621); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16699); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16777); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-vfs

Description

returns sriov-vfs

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16851); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-vf

Description

returns sriov-vf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vf-vlan-filter query No string     This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
vf-mac-filter query No string     When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
vf-vlan-strip query No boolean     When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
neutron-network-id query No string     Neutron network id of the interface

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 16930); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vlans

Description

returns vlans

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17004); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vlan

Description

returns vlan

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17081); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17162); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
interface-id query No string     ID of interface
interface-role query No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17243); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns p-interfaces

Description

returns p-interfaces

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns p-interface

Description

returns p-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17379); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns l-interfaces

Description

returns l-interfaces

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17448); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns l-interface

Description

returns l-interface

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17521); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17598); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17675); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-vfs

Description

returns sriov-vfs

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17748); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-vf

Description

returns sriov-vf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vf-vlan-filter query No string     This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
vf-mac-filter query No string     When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
vf-vlan-strip query No boolean     When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
neutron-network-id query No string     Neutron network id of the interface

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17826); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vlans

Description

returns vlans

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17899); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns vlan

Description

returns vlan

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 17975); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 18055); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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}

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
interface-id query No string     ID of interface
macaddr query No string     MAC address for the interface
network-name query No string     Name of the network
vlan-id-inner query No integer int64   Inner VLAN tag
vpn-key query No string     This indicates the customers VPN ID associated with this vlan
vlan-id-inner query No integer int64   Inner VLAN tag
neutron-network-id query No string     Neutron network id of the interface that address belongs to
neutron-subnet-id query No string     Neutron id of subnet that address belongs to

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 18135); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-pfs

Description

returns sriov-pfs

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns sriov-pf

Description

returns sriov-pf

Parameters

Name Located in Required Type Format Properties Description
hostname path Yes string     Value from executing hostname on the compute node.
interface-name path Yes string     Name that identifies the physical interface
pf-pci-id path Yes string     Identifier for the sriov-pf
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
pserver-id query No string     ID of Pserver
in-maint query No boolean      
pserver-name2 query No string     alternative pserver name
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 18274); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /cloud-infrastructure/virtual-data-centers

Summary

returns virtual-data-centers

Description

returns virtual-data-centers

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns virtual-data-center

Description

returns virtual-data-center

Parameters

Name Located in Required Type Format Properties Description
vdc-id path Yes string     Unique ID of the vdc
vdc-name query No string     Name of the virtual data center

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 18391); backlink

Duplicate explicit target name: "i_1b23a1704dd539ff5fc1c13cc4d3b323".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

EXTERNALSYSTEM

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

Summary

create or update an existing esr-ems

Description

create or update an existing esr-ems

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing esr-system-info

Description

create or update an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18508); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18559); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18609); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing esr-thirdparty-sdnc

Description

create or update an existing esr-thirdparty-sdnc

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing esr-system-info

Description

create or update an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18722); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18773); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18823); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing esr-vnfm

Description

create or update an existing esr-vnfm

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing esr-system-info

Description

create or update an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18936); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 18987); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 19037); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-ems

Description

delete an existing esr-ems

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-system-info

Description

delete an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.
esr-system-info-id path Yes string     Unique ID of esr system info.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-thirdparty-sdnc

Description

delete an existing esr-thirdparty-sdnc

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-system-info

Description

delete an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.
esr-system-info-id path Yes string     Unique ID of esr system info.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-vnfm

Description

delete an existing esr-vnfm

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing esr-system-info

Description

delete an existing esr-system-info

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.
esr-system-info-id path Yes string     Unique ID of esr system info.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.
esr-system-info-id path Yes string     Unique ID of esr system info.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.

Request

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /external-system/esr-ems-list

Summary

returns esr-ems-list

Description

returns esr-ems-list

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-ems

Description

returns esr-ems

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 19694); backlink

Duplicate explicit target name: "i_3fccf9a85a3861b57dcc57e334339914".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info-list

Description

returns esr-system-info-list

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 19757); backlink

Duplicate explicit target name: "i_d4d4306a708cec37f69a432883039d5a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info

Description

returns esr-system-info

Parameters

Name Located in Required Type Format Properties Description
ems-id path Yes string     Unique ID of EMS.
esr-system-info-id path Yes string     Unique ID of esr system info.
system-name query No string     name of external system.
system-type query No string     it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 19823); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-thirdparty-sdnc-list

Description

returns esr-thirdparty-sdnc-list

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-thirdparty-sdnc

Description

returns esr-thirdparty-sdnc

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 19939); backlink

Duplicate explicit target name: "i_bfea90556a85d41982e7041727eb61c0".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info-list

Description

returns esr-system-info-list

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 20002); backlink

Duplicate explicit target name: "i_d4d4306a708cec37f69a432883039d5a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info

Description

returns esr-system-info

Parameters

Name Located in Required Type Format Properties Description
thirdparty-sdnc-id path Yes string     Unique ID of SDNC.
esr-system-info-id path Yes string     Unique ID of esr system info.
system-name query No string     name of external system.
system-type query No string     it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 20068); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

GET /external-system/esr-vnfm-list

Summary

returns esr-vnfm-list

Description

returns esr-vnfm-list

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-vnfm

Description

returns esr-vnfm

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 20184); backlink

Duplicate explicit target name: "i_ef22dc27a0c04bb57ac0f92c2fdd897c".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info-list

Description

returns esr-system-info-list

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 20247); backlink

Duplicate explicit target name: "i_d4d4306a708cec37f69a432883039d5a".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

returns esr-system-info

Description

returns esr-system-info

Parameters

Name Located in Required Type Format Properties Description
vnfm-id path Yes string     Unique ID of VNFM.
esr-system-info-id path Yes string     Unique ID of esr system info.
system-name query No string     name of external system.
system-type query No string     it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.

Request

Responses

200

successful operation

System Message: WARNING/2 (aai_swagger_v11.rst, line 20313); backlink

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Response Schema:

Example:

{}

default

Response codes found in [response codes](https://wiki.onap.org/).

NETWORK

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

Summary

create or update an existing generic-vnf

Description

create or update an existing generic-vnf

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing entitlement

Description

create or update an existing entitlement

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
group-uuid path Yes string     Unique ID for the entitlement group the resource comes from, should be uuid.
resource-uuid path Yes string     Unique ID of an entitlement resource.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
group-uuid path Yes string     Unique ID for the entitlement group the resource comes from, should be uuid.
resource-uuid path Yes string     Unique ID of an entitlement resource.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20483); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing l-interface

Description

create or update an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20540); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20598); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20650); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20708); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20760); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20811); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing sriov-vf

Description

create or update an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20869); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20921); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vlan

Description

create or update an existing vlan

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 20979); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21038); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21091); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21150); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21203); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21255); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing lag-interface

Description

create or update an existing lag-interface

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21312); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing l-interface

Description

create or update an existing l-interface

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21370); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21429); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21482); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21541); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21594); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21646); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing sriov-vf

Description

create or update an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21705); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21758); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vlan

Description

create or update an existing vlan

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21817); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21877); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv4-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21931); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

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

Description

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

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 21991); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
l3-interface-ipv6-address path Yes string     IP address

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22045); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22098); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22149); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing license

Description

create or update an existing license

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
group-uuid path Yes string     Unique ID for the license group the resource belongs to, should be uuid.
resource-uuid path Yes string     Unique ID of a license resource.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
group-uuid path Yes string     Unique ID for the license group the resource belongs to, should be uuid.
resource-uuid path Yes string     Unique ID of a license resource.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22259); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22309); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vf-module

Description

create or update an existing vf-module

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vf-module-id path Yes string     Unique ID of vf-module.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vf-module-id path Yes string     Unique ID of vf-module.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22417); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing instance-group

Description

create or update an existing instance-group

Parameters

Name Located in Required Type Format Properties Description
id path Yes string     Instance Group ID, UUID assigned to this instance.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
id path Yes string     Instance Group ID, UUID assigned to this instance.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22523); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing ipsec-configuration

Description

create or update an existing ipsec-configuration

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22629); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing vig-server

Description

create or update an existing vig-server

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration
vig-address-type path Yes string     indicates whether the VIG is for AVPN or INTERNET

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration
vig-address-type path Yes string     indicates whether the VIG is for AVPN or INTERNET

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22737); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing l3-network

Description

create or update an existing l3-network

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing ctag-assignment

Description

create or update an existing ctag-assignment

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
vlan-id-inner path Yes integer int64   id.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
vlan-id-inner path Yes integer int64   id.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22901); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 22951); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing segmentation-assignment

Description

create or update an existing segmentation-assignment

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
segmentation-id path Yes string     Route Table Reference id, UUID assigned to this instance.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
segmentation-id path Yes string     Route Table Reference id, UUID assigned to this instance.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 23059); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing subnet

Description

create or update an existing subnet

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
subnet-id path Yes string     Subnet ID, should be UUID.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing host-route

Description

create or update an existing host-route

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
subnet-id path Yes string     Subnet ID, should be UUID.
host-route-id path Yes string     host-route id

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
subnet-id path Yes string     Subnet ID, should be UUID.
host-route-id path Yes string     host-route id

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 23226); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
subnet-id path Yes string     Subnet ID, should be UUID.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 23277); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing multicast-configuration

Description

create or update an existing multicast-configuration

Parameters

Name Located in Required Type Format Properties Description
multicast-configuration-id path Yes string     Unique id of multicast configuration.

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
multicast-configuration-id path Yes string     Unique id of multicast configuration.

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 23595); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing network-policy

Description

create or update an existing network-policy

Parameters

Name Located in Required Type Format Properties Description
network-policy-id path Yes string     UUID representing unique key to this instance

Request

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
network-policy-id path Yes string     UUID representing unique key to this instance

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 23701); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

Response codes found in [response codes](https://wiki.onap.org/).

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

Summary

create or update an existing newvce

Description

create or update an existing newvce

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path