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 Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object

Request

Body

{}

Responses

default

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

PUT /network/newvces/newvce/{vnf-id2}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface

Request

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

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

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

PUT /network/newvces/newvce/{vnf-id2}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 23872); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

PUT /network/newvces/newvce/{vnf-id2}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 23924); 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}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 23982); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

PUT /network/newvces/newvce/{vnf-id2}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24034); 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}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface

Request

System Message: WARNING/2 (aai_swagger_v11.rst, line 24085); 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}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24143); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

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

PUT /network/newvces/newvce/{vnf-id2}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24195); 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}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24253); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

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

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

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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24312); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24365); 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}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24424); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24477); 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}/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-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 24529); 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}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}

Summary

create or update an existing pnf

Description

create or update an existing pnf

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.

Request

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

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

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 24856); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 24915); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 24968); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 25027); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25080); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 25132); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 25191); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25244); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 25303); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 25363); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25417); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 25477); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25531); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25584); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
interface-name path Yes string     Name that identifies the link aggregate interface

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
interface-name path Yes string     Name that identifies the physical interface

Request

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

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 25750); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 25809); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25862); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 25921); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 25974); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 26026); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 26085); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 26138); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 26197); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 26257); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 26311); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
pnf-name path Yes string     unique name of Physical Network Function.
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 26371); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 26425); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 26478); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
interface-name path Yes string     Name that identifies the physical interface

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 26587); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 26639); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/route-table-references/route-table-reference/{route-table-reference-id}

Summary

create or update an existing route-table-reference

Description

create or update an existing route-table-reference

Parameters

Name Located in Required Type Format Properties Description
route-table-reference-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/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
route-table-reference-id path Yes string     Route Table Reference id, UUID assigned to this instance.

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Summary

create or update an existing site-pair-set

Description

create or update an existing site-pair-set

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.

Request

Body

{}

Responses

default

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

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing routing-instance

Description

create or update an existing routing-instance

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance

Request

Body

{}

Responses

default

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

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing site-pair

Description

create or update an existing site-pair

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing class-of-service

Description

create or update an existing class-of-service

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe
cos path Yes string     unique identifier of probe

Request

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe
cos path Yes string     unique identifier of probe

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vces/vce/{vnf-id}

Summary

create or update an existing vce

Description

create or update an existing vce

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/vces/vce/{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

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

Duplicate explicit target name: "i_8a45c5f1e5a8567dd5e638a39f50fa80".

Body

{}

Responses

default

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

PUT /network/vces/vce/{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 27397); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vces/vce/{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

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

Duplicate explicit target name: "i_8c3e61f28428e06aef69620bca7330a3".

Body

{}

Responses

default

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

PUT /network/vces/vce/{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 27507); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing port-group

Description

create or update an existing port-group

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-id path Yes string     Unique ID of the interface

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing cvlan-tag-entry

Description

create or update an existing cvlan-tag-entry

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-id path Yes string     Unique ID of the interface
cvlan-tag path Yes integer int64   See mis-na-virtualization-platform.yang

Request

Body

{}

Responses

default

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

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/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-id path Yes string     Unique ID of the interface
cvlan-tag path Yes integer int64   See mis-na-virtualization-platform.yang

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-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-id path Yes string     Unique ID of the interface

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vces/vce/{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 27775); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vnfcs/vnfc/{vnfc-name}

Summary

create or update an existing vnfc

Description

create or update an existing vnfc

Parameters

Name Located in Required Type Format Properties Description
vnfc-name path Yes string     Unique ID of vnfc.

Request

Body

{}

Responses

default

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

PUT /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv4-address path Yes string     IP address

Request

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

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

PUT /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv4-address path Yes string     IP address

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv6-address path Yes string     IP address

Request

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

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

PUT /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv6-address path Yes string     IP address

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnfc-name path Yes string     Unique ID of vnfc.

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}

Summary

create or update an existing vpls-pe

Description

create or update an existing vpls-pe

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      

Request

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface

Request

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

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 28268); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 28327); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 28380); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 28439); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 28492); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 28544); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 28603); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 28656); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 28715); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 28775); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 28829); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 28889); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 28943); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 28996); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface

Request

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

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 29162); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 29221); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 29274); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 29333); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 29386); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 29438); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 29497); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 29550); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 29609); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 29669); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 29723); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

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
equipment-name path Yes string      
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 29783); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 29837); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 29890); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 29999); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 30051); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/vpn-bindings/vpn-binding/{vpn-id}

Summary

create or update an existing vpn-binding

Description

create or update an existing vpn-binding

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI

Request

Body

{}

Responses

default

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

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing route-target

Description

create or update an existing route-target

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
global-route-target path Yes string     Number used to identify an RT, globally unique in the network
route-target-role path Yes string     Role assigned to this route target

Request

Body

{}

Responses

default

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

PUT /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
global-route-target path Yes string     Number used to identify an RT, globally unique in the network
route-target-role path Yes string     Role assigned to this route target

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /network/zones/zone/{zone-id}

Summary

create or update an existing zone

Description

create or update an existing zone

Parameters

Name Located in Required Type Format Properties Description
zone-id path Yes string     Code assigned by AIC to the zone

Request

Body

{}

Responses

default

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

PUT /network/zones/zone/{zone-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
zone-id path Yes string     Code assigned by AIC to the zone

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}

Summary

delete an existing generic-vnf

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing entitlement

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-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
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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
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

Responses

default

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

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

Summary

delete an existing sriov-vf

Description

delete 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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

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
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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/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
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

Responses

default

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

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

Summary

delete an existing license

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

Summary

delete an existing vf-module

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules/vf-module/{vf-module-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/instance-groups/instance-group/{id}

Summary

delete an existing instance-group

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/instance-groups/instance-group/{id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
id path Yes string     Instance Group ID, UUID assigned to this instance.

Request

Responses

default

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

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

Summary

delete an existing ipsec-configuration

Description

delete an existing ipsec-configuration

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration

Request

Responses

default

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

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

Summary

delete an existing vig-server

Description

delete 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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers/vig-server/{vig-address-type}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/l3-networks/l3-network/{network-id}

Summary

delete an existing l3-network

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing ctag-assignment

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/l3-networks/l3-network/{network-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.

Request

Responses

default

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

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Summary

delete an existing segmentation-assignment

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

Summary

delete an existing subnet

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing host-route

Description

delete 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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

DELETE /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

Summary

delete an existing multicast-configuration

Description

delete an existing multicast-configuration

Parameters

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

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

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

Request

Responses

default

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

DELETE /network/network-policies/network-policy/{network-policy-id}

Summary

delete an existing network-policy

Description

delete 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
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/network-policies/network-policy/{network-policy-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
network-policy-id path Yes string     UUID representing unique key to this instance

Request

Responses

default

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

DELETE /network/newvces/newvce/{vnf-id2}

Summary

delete an existing newvce

Description

delete an existing newvce

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface

Request

Responses

default

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

DELETE /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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 /network/newvces/newvce/{vnf-id2}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object

Request

Responses

default

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

DELETE /network/pnfs/pnf/{pnf-name}

Summary

delete an existing pnf

Description

delete an existing pnf

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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 /network/pnfs/pnf/{pnf-name}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.

Request

Responses

default

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

DELETE /network/route-table-references/route-table-reference/{route-table-reference-id}

Summary

delete an existing route-table-reference

Description

delete an existing route-table-reference

Parameters

Name Located in Required Type Format Properties Description
route-table-reference-id path Yes string     Route Table Reference 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 /network/route-table-references/route-table-reference/{route-table-reference-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
route-table-reference-id path Yes string     Route Table Reference id, UUID assigned to this instance.

Request

Responses

default

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Summary

delete an existing site-pair-set

Description

delete an existing site-pair-set

Parameters

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

Request

Responses

default

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.

Request

Responses

default

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

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

Summary

delete an existing routing-instance

Description

delete an existing routing-instance

Parameters

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

Request

Responses

default

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance

Request

Responses

default

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

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

Summary

delete an existing site-pair

Description

delete an existing site-pair

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing class-of-service

Description

delete an existing class-of-service

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe
cos path Yes string     unique identifier of probe
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service/class-of-service/{cos}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe
cos path Yes string     unique identifier of probe

Request

Responses

default

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

DELETE /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe

Request

Responses

default

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

DELETE /network/vces/vce/{vnf-id}

Summary

delete an existing vce

Description

delete an existing vce

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing entitlement

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/vces/vce/{vnf-id}/entitlements/entitlement/{group-uuid}/{resource-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

Summary

delete an existing license

Description

delete 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.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/vces/vce/{vnf-id}/licenses/license/{group-uuid}/{resource-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

Summary

delete an existing port-group

Description

delete an existing port-group

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-id path Yes string     Unique ID of 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 /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}

Summary

delete an existing cvlan-tag-entry

Description

delete an existing cvlan-tag-entry

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-id path Yes string     Unique ID of the interface
cvlan-tag path Yes integer int64   See mis-na-virtualization-platform.yang
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags/cvlan-tag-entry/{cvlan-tag}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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-id path Yes string     Unique ID of the interface
cvlan-tag path Yes integer int64   See mis-na-virtualization-platform.yang

Request

Responses

default

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

DELETE /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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-id path Yes string     Unique ID of the interface

Request

Responses

default

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

DELETE /network/vces/vce/{vnf-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

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

Responses

default

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

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

Summary

delete an existing vnfc

Description

delete an existing vnfc

Parameters

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

Request

Responses

default

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

DELETE /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
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 /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv4-address path Yes string     IP address

Request

Responses

default

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

DELETE /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
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 /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv6-address path Yes string     IP address

Request

Responses

default

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

DELETE /network/vnfcs/vnfc/{vnfc-name}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnfc-name path Yes string     Unique ID of vnfc.

Request

Responses

default

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

DELETE /network/vpls-pes/vpls-pe/{equipment-name}

Summary

delete an existing vpls-pe

Description

delete an existing vpls-pe

Parameters

Name Located in Required Type Format Properties Description
equipment-name 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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Summary

delete an existing sriov-vf

Description

delete an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces/lag-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}

Summary

delete an existing sriov-vf

Description

delete an existing sriov-vf

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/sriov-vfs/sriov-vf/{pci-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv4-address-list/{l3-interface-ipv4-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}

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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/l3-interface-ipv6-address-list/{l3-interface-ipv6-address}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces/p-interface/{interface-name}/l-interfaces/l-interface/{interface-name}/vlans/vlan/{vlan-interface}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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 /network/vpls-pes/vpls-pe/{equipment-name}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      

Request

Responses

default

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

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}

Summary

delete an existing vpn-binding

Description

delete an existing vpn-binding

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI

Request

Responses

default

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

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

Summary

delete an existing route-target

Description

delete an existing route-target

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
global-route-target path Yes string     Number used to identify an RT, globally unique in the network
route-target-role path Yes string     Role assigned to this route target
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets/route-target/{global-route-target}/{route-target-role}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
global-route-target path Yes string     Number used to identify an RT, globally unique in the network
route-target-role path Yes string     Role assigned to this route target

Request

Responses

default

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

DELETE /network/zones/zone/{zone-id}

Summary

delete an existing zone

Description

delete an existing zone

Parameters

Name Located in Required Type Format Properties Description
zone-id path Yes string     Code assigned by AIC to the zone
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /network/zones/zone/{zone-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
zone-id path Yes string     Code assigned by AIC to the zone

Request

Responses

default

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

GET /network/generic-vnfs

Summary

returns generic-vnfs

Description

returns generic-vnfs

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}

Summary

returns generic-vnf

Description

returns 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.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_06a952a9b27a806e71d90d20b21151be".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/entitlements

Summary

returns entitlements

Description

returns entitlements

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns entitlement

Description

returns 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.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_8a45c5f1e5a8567dd5e638a39f50fa80".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces

Summary

returns l-interfaces

Description

returns l-interfaces

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

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

Summary

returns l-interface

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39425); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39513); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39601); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39685); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39774); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/l-interfaces/l-interface/{interface-name}/vlans

Summary

returns vlans

Description

returns vlans

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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39858); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 39945); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40036); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40127); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/lag-interfaces

Summary

returns lag-interfaces

Description

returns lag-interfaces

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_216698be0554f5a3788d247a84f2e261".

Response Schema:

Example:

{}

default

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

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

Summary

returns lag-interface

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40290); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40373); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40460); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40551); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40642); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40729); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

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

Summary

returns sriov-vf

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40821); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40908); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/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
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 40998); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 41092); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns 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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
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 41186); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/licenses

Summary

returns licenses

Description

returns licenses

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns license

Description

returns 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.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_8c3e61f28428e06aef69620bca7330a3".

Response Schema:

Example:

{}

default

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

GET /network/generic-vnfs/generic-vnf/{vnf-id}/vf-modules

Summary

returns vf-modules

Description

returns vf-modules

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns vf-module

Description

returns 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.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
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.
nf-type query No string     Generic description of the type of NF
nf-function query No string     English description of Network function that the specific VNF deployment is providing
nf-role query No string     role in the network that this model will be providing
nf-naming-code query No string     string assigned to this model used for naming purposes
vf-module-name query No string     Name of vf-module
heat-stack-id query No string     Heat stack id corresponding to this 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.
contrail-service-instance-fqdn query No string     the Contrail unique ID for a service-instance

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_1bbfa7555d39dc7b7b5e7e480eb6945a".

Response Schema:

Example:

{}

default

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

GET /network/instance-groups

Summary

returns instance-groups

Description

returns instance-groups

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/instance-groups/instance-group/{id}

Summary

returns instance-group

Description

returns instance-group

Parameters

Name Located in Required Type Format Properties Description
id path Yes string     Instance Group ID, UUID assigned to this instance.
description query No string     Descriptive text to help identify the usage of this instance-group
type query No string     Only valid value today is lower case ha for high availability
sub-type query No string     Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_e76c5bd9f68a202beaf9b58a95a2792e".

Response Schema:

Example:

{}

default

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

GET /network/ipsec-configurations

Summary

returns ipsec-configurations

Description

returns ipsec-configurations

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns ipsec-configuration

Description

returns ipsec-configuration

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_04d523902534cf61e268a9c9a42b7212".

Response Schema:

Example:

{}

default

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

GET /network/ipsec-configurations/ipsec-configuration/{ipsec-configuration-id}/vig-servers

Summary

returns vig-servers

Description

returns vig-servers

Parameters

Name Located in Required Type Format Properties Description
ipsec-configuration-id path Yes string     UUID of this configuration

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns vig-server

Description

returns 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

Responses

200

successful operation

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

Duplicate explicit target name: "i_59ca4cf5d26601abaafb921421316d97".

Response Schema:

Example:

{}

default

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

GET /network/l3-networks

Summary

returns l3-networks

Description

returns l3-networks

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/l3-networks/l3-network/{network-id}

Summary

returns l3-network

Description

returns 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.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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 42003); backlink

Duplicate explicit target name: "i_f87f7544b5e2f8cd20c6cce13c8db09a".

Response Schema:

Example:

{}

default

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

GET /network/l3-networks/l3-network/{network-id}/ctag-assignments

Summary

returns ctag-assignments

Description

returns ctag-assignments

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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 /network/l3-networks/l3-network/{network-id}/ctag-assignments/ctag-assignment/{vlan-id-inner}

Summary

returns ctag-assignment

Description

returns 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.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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 42148); backlink

Duplicate explicit target name: "i_de1d81a4a65ccede72c9ef3492c31014".

Response Schema:

Example:

{}

default

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

GET /network/l3-networks/l3-network/{network-id}/segmentation-assignments

Summary

returns segmentation-assignments

Description

returns segmentation-assignments

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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 /network/l3-networks/l3-network/{network-id}/segmentation-assignments/segmentation-assignment/{segmentation-id}

Summary

returns segmentation-assignment

Description

returns 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.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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 42293); backlink

Duplicate explicit target name: "i_e3d1acc678a798310c1372b634684d81".

Response Schema:

Example:

{}

default

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

GET /network/l3-networks/l3-network/{network-id}/subnets

Summary

returns subnets

Description

returns subnets

Parameters

Name Located in Required Type Format Properties Description
network-id path Yes string     Network ID, should be uuid. Unique across A&AI.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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 /network/l3-networks/l3-network/{network-id}/subnets/subnet/{subnet-id}

Summary

returns subnet

Description

returns 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.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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.
subnet-name query No string     Name associated with the subnet.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_66c5ac4d2c517349c9b71c59a5247423".

Response Schema:

Example:

{}

default

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

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

Summary

returns host-routes

Description

returns host-routes

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.
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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.
subnet-name query No string     Name associated with the subnet.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns host-route

Description

returns 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
network-name query No string     Name of the network, governed by some naming convention..
network-role query No string     Role the network plans - who defines these values?
service-id query No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
contrail-network-fqdn query No string     Contrail FQDN for the network
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.
subnet-name query No string     Name associated with the subnet.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_34f35ddb128093303fb2b49a4e73aa29".

Response Schema:

Example:

{}

default

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

GET /network/multicast-configurations

Summary

returns multicast-configurations

Description

returns multicast-configurations

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns multicast-configuration

Description

returns multicast-configuration

Parameters

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

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_92e93ffdd62377ab9dc3fffbc862167c".

Response Schema:

Example:

{}

default

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

GET /network/network-policies

Summary

returns network-policies

Description

returns network-policies

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/network-policies/network-policy/{network-policy-id}

Summary

returns network-policy

Description

returns network-policy

Parameters

Name Located in Required Type Format Properties Description
network-policy-id path Yes string     UUID representing unique key to this instance
network-policy-fqdn query No string     Contrail FQDN for the policy

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_fd26db9a2279dd3fbcaf00406fe86ec6".

Response Schema:

Example:

{}

default

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

GET /network/newvces

Summary

returns newvces

Description

returns newvces

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}

Summary

returns newvce

Description

returns newvce

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_f65011c27139f53b2910e64160d36358".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/l-interfaces

Summary

returns l-interfaces

Description

returns l-interfaces

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

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

Summary

returns l-interface

Description

returns l-interface

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43322); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
l3-interface-ipv4-address path Yes string     IP address
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43398); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
l3-interface-ipv6-address path Yes string     IP address
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43474); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43546); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
pci-id path Yes string     PCI ID used to identify the sriov-vf
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43623); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/l-interfaces/l-interface/{interface-name}/vlans

Summary

returns vlans

Description

returns vlans

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43695); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/newvces/newvce/{vnf-id2}/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
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
interface-name path Yes string     Name given to the interface
vlan-interface path Yes string     String that identifies the interface
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43770); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43849); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
vnf-id2 path Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
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
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
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 43928); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/pnfs

Summary

returns pnfs

Description

returns pnfs

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}

Summary

returns pnf

Description

returns pnf

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_bc74f61831453678365f7383ad6ca04e".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces

Summary

returns lag-interfaces

Description

returns lag-interfaces

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_216698be0554f5a3788d247a84f2e261".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/lag-interfaces/lag-interface/{interface-name}

Summary

returns lag-interface

Description

returns lag-interface

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44293); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44360); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44431); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44506); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44581); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44652); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44728); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44799); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44873); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 44951); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45029); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/p-interfaces

Summary

returns p-interfaces

Description

returns p-interfaces

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
inv-status query No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_d0190a14e4e5bc559889260e65de4829".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/p-interfaces/p-interface/{interface-name}

Summary

returns p-interface

Description

returns p-interface

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45159); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45225); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45295); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45369); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45443); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45513); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45588); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45658); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45731); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45808); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45885); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 45951); backlink

Duplicate explicit target name: "i_1de2b5d510f62db350e7cb8068745f52".

Response Schema:

Example:

{}

default

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

GET /network/pnfs/pnf/{pnf-name}/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
pnf-name path Yes string     unique name of Physical Network Function.
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.
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 46018); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Response Schema:

Example:

{}

default

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

GET /network/route-table-references

Summary

returns route-table-references

Description

returns route-table-references

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/route-table-references/route-table-reference/{route-table-reference-id}

Summary

returns route-table-reference

Description

returns route-table-reference

Parameters

Name Located in Required Type Format Properties Description
route-table-reference-id path Yes string     Route Table Reference id, UUID assigned to this instance.
route-table-reference-fqdn query No string     FQDN entry in the route table.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_6c59bd944f0e253bb650f63c9e4dd834".

Response Schema:

Example:

{}

default

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

GET /network/site-pair-sets

Summary

returns site-pair-sets

Description

returns site-pair-sets

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}

Summary

returns site-pair-set

Description

returns site-pair-set

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_675943dd0433645a183553fd21389c81".

Response Schema:

Example:

{}

default

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

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances

Summary

returns routing-instances

Description

returns routing-instances

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns routing-instance

Description

returns routing-instance

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_c463eae2ffa9f71f1d8a65995b4c99da".

Response Schema:

Example:

{}

default

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

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

Summary

returns site-pairs

Description

returns site-pairs

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns site-pair

Description

returns site-pair

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_7e476101ecd6c387c928da450a1ab519".

Response Schema:

Example:

{}

default

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

GET /network/site-pair-sets/site-pair-set/{site-pair-set-id}/routing-instances/routing-instance/{routing-instance-id}/site-pairs/site-pair/{site-pair-id}/classes-of-service

Summary

returns classes-of-service

Description

returns classes-of-service

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns class-of-service

Description

returns class-of-service

Parameters

Name Located in Required Type Format Properties Description
site-pair-set-id path Yes string     Unique id of site pair set.
routing-instance-id path Yes string     Unique id of routing instance
site-pair-id path Yes string     unique identifier of probe
cos path Yes string     unique identifier of probe

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_a331a9809d080190768162ebb857b2e4".

Response Schema:

Example:

{}

default

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

GET /network/vces

Summary

returns vces

Description

returns vces

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/vces/vce/{vnf-id}

Summary

returns vce

Description

returns vce

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_f28accb396e15e371eb59af79a5dbe5a".

Response Schema:

Example:

{}

default

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

GET /network/vces/vce/{vnf-id}/entitlements

Summary

returns entitlements

Description

returns entitlements

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_8a1e5d2e049ad99d3a6a6da83108f677".

Response Schema:

Example:

{}

default

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

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

Summary

returns entitlement

Description

returns 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.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_8a45c5f1e5a8567dd5e638a39f50fa80".

Response Schema:

Example:

{}

default

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

GET /network/vces/vce/{vnf-id}/licenses

Summary

returns licenses

Description

returns licenses

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_163851388e8cb25264e921d87c91ca19".

Response Schema:

Example:

{}

default

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

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

Summary

returns license

Description

returns 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.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_8c3e61f28428e06aef69620bca7330a3".

Response Schema:

Example:

{}

default

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

GET /network/vces/vce/{vnf-id}/port-groups

Summary

returns port-groups

Description

returns port-groups

Parameters

Name Located in Required Type Format Properties Description
vnf-id path Yes string     Unique id of VNF. This is unique across the graph.
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns port-group

Description

returns port-group

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-id path Yes string     Unique ID of the interface
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.
port-group-id query No string     Unique ID for port group in vmware
switch-name query No string     DVS or standard switch name (should be non-null for port groups associated with DVS)
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_c3124767cb91aa4d9d4c7ee0534ea230".

Response Schema:

Example:

{}

default

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

GET /network/vces/vce/{vnf-id}/port-groups/port-group/{interface-id}/cvlan-tags

Summary

returns cvlan-tags

Description

returns cvlan-tags

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-id path Yes string     Unique ID of the interface
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.
port-group-id query No string     Unique ID for port group in vmware
switch-name query No string     DVS or standard switch name (should be non-null for port groups associated with DVS)
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns cvlan-tag-entry

Description

returns cvlan-tag-entry

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-id path Yes string     Unique ID of the interface
cvlan-tag path Yes integer int64   See mis-na-virtualization-platform.yang
vnf-name query No string     Name of VNF.
vnf-name2 query No string     Alternate name of VNF.
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.
service-id query No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
regional-resource-zone query No string     Regional way of organizing pservers, source of truth should define values
prov-status query No string     Trigger for operational monitoring of this resource by Service Assurance systems.
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO
vpe-id query No string     Unique ID of VPE connected to this VCE.
port-group-id query No string     Unique ID for port group in vmware
switch-name query No string     DVS or standard switch name (should be non-null for port groups associated with DVS)
heat-stack-id query No string     Heat stack id corresponding to this instance, managed by MSO

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_a144c9d5ef14eadaa000000ee0ec1fe7".

Response Schema:

Example:

{}

default

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

GET /network/vnfcs

Summary

returns vnfcs

Description

returns vnfcs

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/vnfcs/vnfc/{vnfc-name}

Summary

returns vnfc

Description

returns vnfc

Parameters

Name Located in Required Type Format Properties Description
vnfc-name path Yes string     Unique ID of vnfc.
nfc-naming-code query No string     Short code that is used in naming instances of the item being modeled
nfc-function query No string     English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
prov-status query No string     prov status of this vnfc
ipaddress-v4-oam-vip query No string     Oam V4 vip address of this vnfc
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
group-notation query No string     Group notation of VNFC
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.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_120d1487fd3ba7687158894ca473218c".

Response Schema:

Example:

{}

default

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

GET /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv4-address path Yes string     IP address
nfc-naming-code query No string     Short code that is used in naming instances of the item being modeled
nfc-function query No string     English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
prov-status query No string     prov status of this vnfc
ipaddress-v4-oam-vip query No string     Oam V4 vip address of this vnfc
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
group-notation query No string     Group notation of VNFC
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.
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 47548); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

GET /network/vnfcs/vnfc/{vnfc-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
vnfc-name path Yes string     Unique ID of vnfc.
l3-interface-ipv6-address path Yes string     IP address
nfc-naming-code query No string     Short code that is used in naming instances of the item being modeled
nfc-function query No string     English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
prov-status query No string     prov status of this vnfc
ipaddress-v4-oam-vip query No string     Oam V4 vip address of this vnfc
in-maint query No boolean      
is-closed-loop-disabled query No boolean      
group-notation query No string     Group notation of VNFC
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.
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 47624); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes

Summary

returns vpls-pes

Description

returns vpls-pes

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}

Summary

returns vpls-pe

Description

returns vpls-pe

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_b7200ee27877b16bc58e6ed01696c38c".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/lag-interfaces

Summary

returns lag-interfaces

Description

returns lag-interfaces

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_216698be0554f5a3788d247a84f2e261".

Response Schema:

Example:

{}

default

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

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

Summary

returns lag-interface

Description

returns lag-interface

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 47872); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 47939); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48010); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48085); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48160); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48231); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

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

Summary

returns sriov-vf

Description

returns sriov-vf

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48307); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the link aggregate interface
interface-name path Yes string     Name given to the interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48378); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48452); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48530); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48608); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/p-interfaces

Summary

returns p-interfaces

Description

returns p-interfaces

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_d0190a14e4e5bc559889260e65de4829".

Response Schema:

Example:

{}

default

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

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

Summary

returns p-interface

Description

returns p-interface

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48738); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48804); backlink

Duplicate explicit target name: "i_cd0818a18a695fae4f5ff2e6352143d8".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48874); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 48948); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49022); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49092); backlink

Duplicate explicit target name: "i_304f776b0215dd0b7ca4ad92ef9941fa".

Response Schema:

Example:

{}

default

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

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

Summary

returns sriov-vf

Description

returns sriov-vf

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49167); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
interface-name path Yes string     Name given to the interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49237); backlink

Duplicate explicit target name: "i_02096319f42d19f74f74003e77de23a8".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49310); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv4-address-list

Description

returns l3-interface-ipv4-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49387); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

Response Schema:

Example:

{}

default

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

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

Summary

returns l3-interface-ipv6-address-list

Description

returns l3-interface-ipv6-address-list

Parameters

Name Located in Required Type Format Properties Description
equipment-name path Yes string      
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
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49464); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49530); backlink

Duplicate explicit target name: "i_1de2b5d510f62db350e7cb8068745f52".

Response Schema:

Example:

{}

default

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

GET /network/vpls-pes/vpls-pe/{equipment-name}/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
equipment-name path Yes string      
interface-name path Yes string     Name that identifies the physical interface
pf-pci-id path Yes string     Identifier for the sriov-pf
prov-status query No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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 49597); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Response Schema:

Example:

{}

default

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

GET /network/vpn-bindings

Summary

returns vpn-bindings

Description

returns vpn-bindings

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/vpn-bindings/vpn-binding/{vpn-id}

Summary

returns vpn-binding

Description

returns vpn-binding

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
vpn-name query No string     VPN Name
vpn-type query No string     Type of the vpn, should be taken from enumerated/valid values

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_9748245f68da65b38b1103b9df0fd5b4".

Response Schema:

Example:

{}

default

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

GET /network/vpn-bindings/vpn-binding/{vpn-id}/route-targets

Summary

returns route-targets

Description

returns route-targets

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
vpn-name query No string     VPN Name
vpn-type query No string     Type of the vpn, should be taken from enumerated/valid values

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns route-target

Description

returns route-target

Parameters

Name Located in Required Type Format Properties Description
vpn-id path Yes string     VPN ID, globally unique within A&AI
global-route-target path Yes string     Number used to identify an RT, globally unique in the network
route-target-role path Yes string     Role assigned to this route target
vpn-name query No string     VPN Name
vpn-type query No string     Type of the vpn, should be taken from enumerated/valid values

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_e84ce49cb4046bddbb69dcc1a6208b03".

Response Schema:

Example:

{}

default

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

GET /network/zones

Summary

returns zones

Description

returns zones

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /network/zones/zone/{zone-id}

Summary

returns zone

Description

returns zone

Parameters

Name Located in Required Type Format Properties Description
zone-id path Yes string     Code assigned by AIC to the zone
design-type query No string     Design of zone [Medium/Large?]
zone-context query No string     Context of zone [production/test]

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_b071e942df8c17072bdd019656cdefbc".

Response Schema:

Example:

{}

default

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

SERVICEDESIGNANDCREATION

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

Summary

create or update an existing model

Description

create or update an existing model

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing model-ver

Description

create or update an existing model-ver

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC

Request

Body

{}

Responses

default

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

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-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
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
metaname path Yes string      

Request

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

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Body

{}

Responses

default

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

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

Summary

create or update an existing model-element

Description

create or update an existing model-element

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing model-constraint

Description

create or update an existing model-constraint

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing constrained-element-set

Description

create or update an existing constrained-element-set

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing element-choice-set

Description

create or update an existing element-choice-set

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
element-choice-set-uuid path Yes string      

Request

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
element-choice-set-uuid path Yes string      

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing named-query

Description

create or update an existing named-query

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing named-query-element

Description

create or update an existing named-query-element

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      

Request

Body

{}

Responses

default

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

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

Summary

create or update an existing property-constraint

Description

create or update an existing property-constraint

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      
property-constraint-uuid path Yes string      

Request

Body

{}

Responses

default

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

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing service-capability

Description

create or update an existing service-capability

Parameters

Name Located in Required Type Format Properties Description
service-type path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
vnf-type path Yes 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

Body

{}

Responses

default

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

PUT /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
service-type path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
vnf-type path Yes 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

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

PUT /service-design-and-creation/services/service/{service-id}

Summary

create or update an existing service

Description

create or update an existing service

Parameters

Name Located in Required Type Format Properties Description
service-id path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.

Request

Body

{}

Responses

default

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

PUT /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
service-id path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

create or update an existing vnf-image

Description

create or update an existing vnf-image

Parameters

Name Located in Required Type Format Properties Description
vnf-image-uuid path Yes string     Unique ID of this asset

Request

Body

{}

Responses

default

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

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

Summary

see node definition for valid relationships

Parameters

Name Located in Required Type Format Properties Description
vnf-image-uuid path Yes string     Unique ID of this asset

Request

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Body

{}

Responses

default

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

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

Summary

delete an existing model

Description

delete an existing model

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing model-ver

Description

delete an existing model-ver

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing metadatum

Description

delete an existing metadatum

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
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 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}

Summary

delete an existing model-element

Description

delete an existing model-element

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid 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 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}

Summary

delete an existing model-constraint

Description

delete an existing model-constraint

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid 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 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}

Summary

delete an existing constrained-element-set

Description

delete an existing constrained-element-set

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid 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 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}

Summary

delete an existing element-choice-set

Description

delete an existing element-choice-set

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
element-choice-set-uuid 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 /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/model-constraints/model-constraint/{model-constraint-uuid}/constrained-element-sets/constrained-element-set/{constrained-element-set-uuid}/element-choice-sets/element-choice-set/{element-choice-set-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
element-choice-set-uuid path Yes string      

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      

Request

Responses

default

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

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements/model-element/{model-element-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      

Request

Responses

default

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

DELETE /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC

Request

Responses

default

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

DELETE /service-design-and-creation/models/model/{model-invariant-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC

Request

Responses

default

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

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

Summary

delete an existing named-query

Description

delete an existing named-query

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid 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 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}

Summary

delete an existing named-query-element

Description

delete an existing named-query-element

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid 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 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/property-constraints/property-constraint/{property-constraint-uuid}

Summary

delete an existing property-constraint

Description

delete an existing property-constraint

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      
property-constraint-uuid 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 /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements/named-query-element/{named-query-element-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      

Request

Responses

default

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

DELETE /service-design-and-creation/named-queries/named-query/{named-query-uuid}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      

Request

Responses

default

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

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

Summary

delete an existing service-capability

Description

delete an existing service-capability

Parameters

Name Located in Required Type Format Properties Description
service-type path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
vnf-type path Yes string     String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /service-design-and-creation/service-capabilities/service-capability/{service-type}/{vnf-type}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
service-type path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
vnf-type path Yes 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

default

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

DELETE /service-design-and-creation/services/service/{service-id}

Summary

delete an existing service

Description

delete an existing service

Parameters

Name Located in Required Type Format Properties Description
service-id path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

DELETE /service-design-and-creation/services/service/{service-id}/relationship-list/relationship

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
service-id path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.

Request

Responses

default

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

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

Summary

delete an existing vnf-image

Description

delete an existing vnf-image

Parameters

Name Located in Required Type Format Properties Description
vnf-image-uuid path Yes string     Unique ID of this asset
resource-version query Yes string     resource-version for concurrency

Request

Responses

default

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

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

Summary

delete an existing relationship

Description

delete an existing relationship

Parameters

Name Located in Required Type Format Properties Description
vnf-image-uuid path Yes string     Unique ID of this asset

Request

Responses

default

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

GET /service-design-and-creation/models

Summary

returns models

Description

returns models

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns model

Description

returns model

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-type query No string     Type of the model, e.g., service, resource, widget, etc.

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_41777cd8804da9ec90bd3c37d52921e6".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers

Summary

returns model-vers

Description

returns model-vers

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-type query No string     Type of the model, e.g., service, resource, widget, etc.

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns model-ver

Description

returns model-ver

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_9171944339ceb27c07d127d2245a8af5".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/metadata

Summary

returns metadata

Description

returns metadata

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_c1c8a58aeed68efb121284a09febd9c2".

Response Schema:

Example:

{}

default

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

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

Summary

returns metadatum

Description

returns metadatum

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
metaname path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/models/model/{model-invariant-id}/model-vers/model-ver/{model-version-id}/model-elements

Summary

returns model-elements

Description

returns model-elements

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns model-element

Description

returns model-element

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_6b76f1338d485d58b2e7daab4fcf5705".

Response Schema:

Example:

{}

default

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

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

Summary

returns model-constraints

Description

returns model-constraints

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns model-constraint

Description

returns model-constraint

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_7e698f4048064278327d70b0e968c2da".

Response Schema:

Example:

{}

default

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

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

Summary

returns constrained-element-sets

Description

returns constrained-element-sets

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns constrained-element-set

Description

returns constrained-element-set

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_a7dd9ea3d17271f7b74122224690347f".

Response Schema:

Example:

{}

default

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

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

Summary

returns element-choice-sets

Description

returns element-choice-sets

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns element-choice-set

Description

returns element-choice-set

Parameters

Name Located in Required Type Format Properties Description
model-invariant-id path Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-version-id path Yes string     Unique identifier corresponding to one version of a model in ASDC
model-element-uuid path Yes string      
model-constraint-uuid path Yes string      
constrained-element-set-uuid path Yes string      
element-choice-set-uuid path Yes string      
model-type query No string     Type of the model, e.g., service, resource, widget, etc.
model-name query No string     Name of the model, which can change from version to version.
model-version query No string     Version

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_dfac5d15799975fca11bb9fd17f1aa4e".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/named-queries

Summary

returns named-queries

Description

returns named-queries

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns named-query

Description

returns named-query

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-name query No string      

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_fc6cb4831a97be8ac00f8f7dc7cc479e".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/named-queries/named-query/{named-query-uuid}/named-query-elements

Summary

returns named-query-elements

Description

returns named-query-elements

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-name query No string      

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns named-query-element

Description

returns named-query-element

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      
named-query-name query No string      

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_8380f69635d0e9fe0bf3bfa08e1c824b".

Response Schema:

Example:

{}

default

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

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

Summary

returns property-constraints

Description

returns property-constraints

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      
named-query-name query No string      

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns property-constraint

Description

returns property-constraint

Parameters

Name Located in Required Type Format Properties Description
named-query-uuid path Yes string      
named-query-element-uuid path Yes string      
property-constraint-uuid path Yes string      
named-query-name query No string      

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_0ae597bc5f078bbe4b4bf13aa13dd7c5".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/service-capabilities

Summary

returns service-capabilities

Description

returns service-capabilities

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns service-capability

Description

returns service-capability

Parameters

Name Located in Required Type Format Properties Description
service-type path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
vnf-type path Yes 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 54056); backlink

Duplicate explicit target name: "i_df020d185ca9ad35b22723ace6bb6aa5".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/services

Summary

returns services

Description

returns services

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/services/service/{service-id}

Summary

returns service

Description

returns service

Parameters

Name Located in Required Type Format Properties Description
service-id path Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
service-description query No string     Description of the service

Request

Responses

200

successful operation

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

Duplicate explicit target name: "i_87ea7700cb017e8a1daea49f67896277".

Response Schema:

Example:

{}

default

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

GET /service-design-and-creation/vnf-images

Summary

returns vnf-images

Description

returns vnf-images

Request

Responses

200

successful operation

Response Schema:

Example:

{}

default

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

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

Summary

returns vnf-image

Description

returns vnf-image

Parameters

Name Located in Required Type Format Properties Description
vnf-image-uuid path Yes string     Unique ID of this asset
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 54292); backlink

Duplicate explicit target name: "i_b72cbb3c300ae4fc4ee8fb19b5a89d04".

Response Schema:

Example:

{}

default

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

Data Structures

action Model Structure

Name Required Type Format Properties Description
action-data No

array of :ref:`action-data <i_842a9e39d8c9d98085b658e9ffa7bdb6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54327); backlink

Unknown interpreted text role "ref".
      
action-type No string      

Action-data schema:

action-data Model Structure

Name Required Type Format Properties Description
property-name No string      
property-value No string      

actions Model Structure

APIs that are more action related than REST (e.g., notify, update).

Name Required Type Format Properties Description
notify No

:ref:`notify <i_65b8404501b3fece756fb5e48bccebf6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54363); backlink

Unknown interpreted text role "ref".
      
update No

:ref:`update <i_bdf358f57a57b75c20c188ffd6abd2c4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54363); backlink

Unknown interpreted text role "ref".
      

Notify schema:

Update schema:

allotted-resource Model Structure

Represents a slice or partial piece of a resource that gets separately allotted ###### Related Nodes - TO generic-vnf (Many2Many) - TO l3-network (Many2Many) - TO instance-group (Many2Many) - TO network-policy (One2One) - TO vlan (Many2Many) - TO l-interface (One2Many) - TO tunnel-xconnect (comprises allotted-resource, One2One) - TO vpn-binding (Many2Many) - TO allotted-resource (One2One) - FROM configuration - FROM service-instance (is composed of allotted-resource) - FROM service-instance - FROM allotted-resource

Name Required Type Format Properties Description
description No string     The descriptive information assigned to this allotted resource instance
id Yes string     Allotted Resource id UUID assigned to this instance.
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
operational-status No string     Indicator for whether the resource is considered operational
orchestration-status No string     Orchestration status
persona-model-version No string     the ASDC model version for this resource or service model.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54407); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Concurrency value
role No string     role in the network that this resource will be providing.
selflink No string     Link back to more information in the controller
tunnel-xconnects No

array of :ref:`tunnel-xconnects <i_2ebe2510685b62f9169f78f937be32d6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54407); backlink

Unknown interpreted text role "ref".
      
type No string     Generic description of the type of allotted resource.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_2ebe2510685b62f9169f78f937be32d6".

Tunnel-xconnects schema:

allotted-resources Model Structure

This object is used to store slices of services being offered

Name Required Type Format Properties Description
allotted-resource No

array of :ref:`allotted-resources <i_525457a1212e4a768697d3941f0768b7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54448); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_525457a1212e4a768697d3941f0768b7".

Allotted-resources schema:

availability-zone Model Structure

Availability zone, a collection of compute hosts/pservers ###### Related Nodes - TO complex (Many2Many) - TO service-capability (Many2Many) - FROM cloud-region (is composed of availability-zone) - FROM ctag-pool - FROM dvs-switch - FROM generic-vnf - FROM pserver - FROM vce

Name Required Type Format Properties Description
availability-zone-name Yes string     Name of the availability zone. Unique across a cloud region
hypervisor-type Yes string     Type of hypervisor. Source of truth should define valid values.
operational-status No string     State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54479); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

availability-zones Model Structure

Collection of availability zones

Name Required Type Format Properties Description
availability-zone No

array of :ref:`availability-zones <i_b42d7482046b4d4973a9d394b5902058>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54505); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_b42d7482046b4d4973a9d394b5902058".

Availability-zones schema:

az-and-dvs-switches Model Structure

Name Required Type Format Properties Description
availability-zone No

:ref:`availability-zone <i_142d480095c4e740b5263fc3bd0e18ec>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54524); backlink

Unknown interpreted text role "ref".
      
dvs-switches No

:ref:`dvs-switches <i_8e01c4c93e30e4328cd0b2b73fa71f4a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54524); backlink

Unknown interpreted text role "ref".
      

Availability-zone schema:

Dvs-switches schema:

business Model Structure

Namespace for business related constructs

Name Required Type Format Properties Description
connectors No

array of :ref:`connectors <i_dc3b96be71def44ce61f5197b9e0d9a9>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54554); backlink

Unknown interpreted text role "ref".
      
customers No

array of :ref:`customer <i_fce907b082d29cb942cbdd1e9fd68abf>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54554); backlink

Unknown interpreted text role "ref".
      
lines-of-business No

array of :ref:`lines-of-business <i_4c9a2ed440bf1a52cb5c6f554b57c866>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54554); backlink

Unknown interpreted text role "ref".
      
owning-entities No

array of :ref:`owning-entities <i_2d49ced111ed3ef9a5e3f7d84059b8e2>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54554); backlink

Unknown interpreted text role "ref".
      
platforms No

array of :ref:`platform <i_bbf1456f16dc4f9e3f0edfb0db178ae4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54554); backlink

Unknown interpreted text role "ref".
      
projects No

array of :ref:`project <i_eccf78fe69afe99ba1b502bbdeacced3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54554); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_dc3b96be71def44ce61f5197b9e0d9a9".

Connectors schema:

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

Duplicate explicit target name: "i_fce907b082d29cb942cbdd1e9fd68abf".

Customer schema:

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

Duplicate explicit target name: "i_4c9a2ed440bf1a52cb5c6f554b57c866".

Lines-of-business schema:

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

Duplicate explicit target name: "i_2d49ced111ed3ef9a5e3f7d84059b8e2".

Owning-entities schema:

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

Duplicate explicit target name: "i_bbf1456f16dc4f9e3f0edfb0db178ae4".

Platform schema:

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

Duplicate explicit target name: "i_eccf78fe69afe99ba1b502bbdeacced3".

Project schema:

class-of-service Model Structure

###### Related Nodes - FROM site-pair (is composed of class-of-service)

Name Required Type Format Properties Description
cos Yes string     unique identifier of probe
probe-id No string     identifier of probe
probe-type No string     type of probe
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54617); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

classes-of-service Model Structure

class-of-service of probe

Name Required Type Format Properties Description
class-of-service No

array of :ref:`class-of-service <i_a331a9809d080190768162ebb857b2e4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54643); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_a331a9809d080190768162ebb857b2e4".

Class-of-service schema:

cloud-infrastructure Model Structure

Namespace for cloud infrastructure.

Name Required Type Format Properties Description
cloud-regions No

array of :ref:`cloud-region <i_6734175ee148fd23afbc840cc3ae1365>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54665); backlink

Unknown interpreted text role "ref".
      
complexes No

array of :ref:`complexes <i_b886c673cb6f4cb1994b52b0959747fd>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54665); backlink

Unknown interpreted text role "ref".
      
network-profiles No

array of :ref:`network-profile <i_a50e1b79cd43e4089afc53d6a882521a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54665); backlink

Unknown interpreted text role "ref".
      
pservers No

array of :ref:`pserver <i_52218c7dbc286864a4a5e4cdc72d4f10>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54665); backlink

Unknown interpreted text role "ref".
      
virtual-data-centers No

array of :ref:`virtual-data-center <i_1b23a1704dd539ff5fc1c13cc4d3b323>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54665); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_6734175ee148fd23afbc840cc3ae1365".

Cloud-region schema:

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

Duplicate explicit target name: "i_b886c673cb6f4cb1994b52b0959747fd".

Complexes schema:

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

Duplicate explicit target name: "i_a50e1b79cd43e4089afc53d6a882521a".

Network-profile schema:

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

Duplicate explicit target name: "i_52218c7dbc286864a4a5e4cdc72d4f10".

Pserver schema:

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

Duplicate explicit target name: "i_1b23a1704dd539ff5fc1c13cc4d3b323".

Virtual-data-center schema:

cloud-region Model Structure

cloud-region designates an installation of a cloud cluster or region or instantiation. ###### Related Nodes - TO esr-system-info (comprises cloud-region, One2Many) - TO complex (Many2One) - TO l3-network (Many2Many) - TO tenant (comprises cloud-region, One2Many) - TO image (comprises cloud-region, One2Many) - TO flavor (comprises cloud-region, One2Many) - TO availability-zone (comprises cloud-region, One2Many) - TO oam-network (comprises cloud-region, One2Many) - TO dvs-switch (comprises cloud-region, One2Many) - TO volume-group (comprises cloud-region, One2Many) - TO group-assignment (comprises cloud-region, One2Many) - TO snapshot (comprises cloud-region, One2Many) - TO zone (Many2One) - TO vip-ipv4-address-list (comprises cloud-region, One2Many) - TO vip-ipv6-address-list (comprises cloud-region, One2Many) - FROM pserver - FROM logical-link

Name Required Type Format Properties Description
availability-zones No

array of :ref:`availability-zones <i_b42d7482046b4d4973a9d394b5902058>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
cloud-epa-caps No string     MultiVIM will discover and expose EPA capabilities.
cloud-extra-info No string     ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
cloud-owner Yes string     Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
cloud-region-id Yes string     Identifier used by the vendor for the region. Second part of composite key
cloud-region-version No string     Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
cloud-type No string     Type of the cloud (e.g., openstack)
cloud-zone No string     Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
complex-name No string     complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
dvs-switches No

array of :ref:`dvs-switch <i_20b6ce1bb4c6db9e7b571ea785fad8bc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
esr-system-info-list No

array of :ref:`esr-system-info-list <i_ec912415b8198a1e64856d6e73301049>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
flavors No

array of :ref:`flavor <i_571f5e6060c4735fc4a3a8405ac27d0d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
group-assignments No

array of :ref:`group-assignment <i_f6c140e75861964f717c02c75fb09721>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
identity-url No string     URL of the keystone identity service
images No

array of :ref:`image <i_a51c24325979e69e4cfe99e2a92eae43>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
oam-networks No

array of :ref:`oam-network <i_1e18de35af33a443b1075762d99f74ca>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
owner-defined-type No string     Cloud-owner defined type indicator (e.g., dcp, lcp)
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
snapshots No

array of :ref:`snapshot <i_f766386b482511567bb8cf26fce6a7e7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
sriov-automation Yes boolean      
tenants No

array of :ref:`tenant <i_f330302f0065d2bdb215cc9170d4091e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
vip-ipv4-address-list No

array of :ref:`vip-ipv4-address-list <i_c642e7ae284cb2ffe94c3d2028fc0835>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
vip-ipv6-address-list No

array of :ref:`vip-ipv6-address-list <i_e3de5be9093341a784feaac64508a2a4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      
volume-groups No

array of :ref:`volume-group <i_9d66516837e3c652ee9f0a21a5bd748e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54737); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_b42d7482046b4d4973a9d394b5902058".

Availability-zones schema:

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

Duplicate explicit target name: "i_20b6ce1bb4c6db9e7b571ea785fad8bc".

Dvs-switch schema:

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

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Esr-system-info-list schema:

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

Duplicate explicit target name: "i_571f5e6060c4735fc4a3a8405ac27d0d".

Flavor schema:

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

Duplicate explicit target name: "i_f6c140e75861964f717c02c75fb09721".

Group-assignment schema:

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

Duplicate explicit target name: "i_a51c24325979e69e4cfe99e2a92eae43".

Image schema:

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

Duplicate explicit target name: "i_1e18de35af33a443b1075762d99f74ca".

Oam-network schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_f766386b482511567bb8cf26fce6a7e7".

Snapshot schema:

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

Duplicate explicit target name: "i_f330302f0065d2bdb215cc9170d4091e".

Tenant schema:

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

Duplicate explicit target name: "i_c642e7ae284cb2ffe94c3d2028fc0835".

Vip-ipv4-address-list schema:

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

Duplicate explicit target name: "i_e3de5be9093341a784feaac64508a2a4".

Vip-ipv6-address-list schema:

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

Duplicate explicit target name: "i_9d66516837e3c652ee9f0a21a5bd748e".

Volume-group schema:

cloud-regions Model Structure

Name Required Type Format Properties Description
cloud-region No

array of :ref:`cloud-region <i_6734175ee148fd23afbc840cc3ae1365>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54864); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_6734175ee148fd23afbc840cc3ae1365".

Cloud-region schema:

complex Model Structure

Collection of physical locations that can house cloud-regions. ###### Related Nodes - TO ctag-pool (comprises complex, Many2Many) - TO l3-network (Many2Many) - FROM availability-zone - FROM cloud-region - FROM oam-network - FROM pserver - FROM pnf - FROM vce - FROM vpls-pe - FROM volume-group - FROM zone - FROM generic-vnf

Name Required Type Format Properties Description
city Yes string      
complex-name No string     Gamma complex name for LCP instance.
country Yes string      
ctag-pools No

array of :ref:`ctag-pool <i_61de10ec6864ae7434ce7296170afd37>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54899); backlink

Unknown interpreted text role "ref".
      
data-center-code No string     Data center code which can be an alternate way to identify a complex
elevation No string      
identity-url No string     URL of the keystone identity service
lata No string      
latitude No string      
longitude No string      
physical-location-id Yes string     Unique identifier for physical location, e.g., CLLI
physical-location-type Yes string     Type, e.g., central office, data center.
postal-code Yes string      
region Yes string      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54899); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
state No string      
street1 Yes string      
street2 No string      

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

Duplicate explicit target name: "i_61de10ec6864ae7434ce7296170afd37".

Ctag-pool schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

complexes Model Structure

Collection of physical locations that can house cloud-regions.

Name Required Type Format Properties Description
complex No

array of :ref:`complexes <i_b886c673cb6f4cb1994b52b0959747fd>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54946); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_b886c673cb6f4cb1994b52b0959747fd".

Complexes schema:

configuration Model Structure

Port Mirror Configuration. ###### Related Nodes - TO logical-link (One2Many) - TO metadatum (comprises configuration, One2Many) - TO allotted-resource (One2One) - FROM service-instance - FROM generic-vnf

Name Required Type Format Properties Description
configuration-id Yes string     UUID assigned to configuration.
configuration-name No string     Name of the configuration.
configuration-selflink Yes string     URL to endpoint where AAI can get more details from SDN-GC.
configuration-sub-type Yes string     vprobe, pprobe.
configuration-type Yes string     port-mirroring-configuration.
management-option No string     Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
metadata No

:ref:`metadata <i_dea1714aa48a61e30afd7fca1dfdcd5e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54974); backlink

Unknown interpreted text role "ref".
      
model-customization-id Yes string     id of the configuration used to customize the resource
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
operational-status Yes string     Indicator for whether the resource is considered operational.
orchestration-status Yes string     Orchestration status of the configuration.
relationship-list No

:ref:`relationship-list <i_843e57e113524c26549cec942567cde2>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 54974); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

Metadata schema:

Relationship-list schema:

configurations Model Structure

Collection of configurations

Name Required Type Format Properties Description
configuration No

array of :ref:`configuration <i_b5360fa03ff612f215f406242902349c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55016); backlink

Unknown interpreted text role "ref".
      

Configuration schema:

connector Model Structure

Collection of resource instances used to connect a variety of disparate inventory widgets ###### Related Nodes - TO virtual-data-center (Many2Many) - TO metadatum (comprises connector, Many2Many) - FROM service-instance

Name Required Type Format Properties Description
metadata No

array of :ref:`metadata <i_6fb4789e41f9c692fc0616c746add31a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55042); backlink

Unknown interpreted text role "ref".
      
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
persona-model-version No string     the ASDC model version for this resource or service model.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55042); backlink

Unknown interpreted text role "ref".
      
resource-instance-id Yes string     Unique id of resource instance.
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
widget-model-id No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

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

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Metadata schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

connectors Model Structure

Collection of resource instances used to connect a variety of disparate inventory widgets

Name Required Type Format Properties Description
connector No

array of :ref:`connectors <i_dc3b96be71def44ce61f5197b9e0d9a9>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55079); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_dc3b96be71def44ce61f5197b9e0d9a9".

Connectors schema:

constrained-element-set Model Structure

This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - TO element-choice-set (comprises constrained-element-set, One2Many) - FROM model-element (is composed of constrained-element-set) - FROM model-constraint (is composed of constrained-element-set)

Name Required Type Format Properties Description
check-type Yes string      
constrained-element-set-uuid Yes string      
constraint-type Yes string      
element-choice-sets No

array of :ref:`element-choice-sets <i_dfac5d15799975fca11bb9fd17f1aa4e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55105); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55105); backlink

Unknown interpreted text role "ref".
      
resource-version No string      

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

Duplicate explicit target name: "i_dfac5d15799975fca11bb9fd17f1aa4e".

Element-choice-sets schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

constrained-element-sets Model Structure

Name Required Type Format Properties Description
constrained-element-set No

array of :ref:`constrained-element-sets <i_a7dd9ea3d17271f7b74122224690347f>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55136); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_a7dd9ea3d17271f7b74122224690347f".

Constrained-element-sets schema:

ctag-assignment Model Structure

###### Related Nodes - FROM l3-network (is composed of ctag-assignment) - FROM service-instance

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55160); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vlan-id-inner Yes integer int64   id.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

ctag-assignments Model Structure

Name Required Type Format Properties Description
ctag-assignment No

array of :ref:`ctag-assignment <i_de1d81a4a65ccede72c9ef3492c31014>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55181); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_de1d81a4a65ccede72c9ef3492c31014".

Ctag-assignment schema:

ctag-pool Model Structure

A collection of C tags (vlan tags) grouped for a specific purpose. ###### Related Nodes - TO availability-zone (Many2Many) - FROM complex (is composed of ctag-pool) - FROM vpls-pe - FROM generic-vnf

Name Required Type Format Properties Description
availability-zone-name Yes string     Name of the availability zone
ctag-pool-purpose Yes string     Describes what the intended purpose of this pool is.
ctag-values No string     Comma separated list of ctags
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55208); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
target-pe Yes string     The Target provider edge router

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

ctag-pools Model Structure

Name Required Type Format Properties Description
ctag-pool No

array of :ref:`ctag-pool <i_61de10ec6864ae7434ce7296170afd37>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55232); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_61de10ec6864ae7434ce7296170afd37".

Ctag-pool schema:

customer Model Structure

customer identifiers to provide linkage back to BSS information. ###### Related Nodes - TO service-subscription (comprises customer, Many2Many)

Name Required Type Format Properties Description
global-customer-id Yes string     Global customer id used across ECOMP to uniquely identify customer.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55256); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service-subscriptions No

array of :ref:`service-subscription <i_dd892e6b73902e5e959a9b8fc37a8ed3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55256); backlink

Unknown interpreted text role "ref".
      
subscriber-name Yes string     Subscriber name, an alternate way to retrieve a customer.
subscriber-type Yes string     Subscriber type, a way to provide VID with only the INFRA customers.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_dd892e6b73902e5e959a9b8fc37a8ed3".

Service-subscription schema:

customers Model Structure

Collection of customer identifiers to provide linkage back to BSS information.

Name Required Type Format Properties Description
customer No

array of :ref:`customer <i_fce907b082d29cb942cbdd1e9fd68abf>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55290); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_fce907b082d29cb942cbdd1e9fd68abf".

Customer schema:

cvlan-tag-entry Model Structure

Name Required Type Format Properties Description
cvlan-tag Yes integer int64   See mis-na-virtualization-platform.yang
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55309); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

cvlan-tags Model Structure

Name Required Type Format Properties Description
cvlan-tag-entry No

array of :ref:`cvlan-tag-entry <i_a144c9d5ef14eadaa000000ee0ec1fe7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55330); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_a144c9d5ef14eadaa000000ee0ec1fe7".

Cvlan-tag-entry schema:

dvs-switch Model Structure

Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI. ###### Related Nodes - TO availability-zone (Many2Many) - FROM cloud-region (is composed of dvs-switch)

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55355); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
switch-name Yes string     DVS switch name
vcenter-url Yes string     URL used to reach the vcenter

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

dvs-switches Model Structure

Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.

Name Required Type Format Properties Description
dvs-switch No

array of :ref:`dvs-switch <i_20b6ce1bb4c6db9e7b571ea785fad8bc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55380); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_20b6ce1bb4c6db9e7b571ea785fad8bc".

Dvs-switch schema:

edge-prop-names Model Structure

Internal map to define the properties of an edge and interpret the map EdgeRules

Name Required Type Format Properties Description
SVC-INFRA No string      
contains-other-v No string      
delete-other-v No string      
direction No string      
edgeLabel No string      
multiplicityRule No string      
prevent-delete No string      

edge-tag-query-request Model Structure

Name Required Type Format Properties Description
edge-tag No string      
include-node-filter No

array of :ref:`include-node-filter <i_6fa9e2ab9d2a473bedd0bfe2d119108f>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55420); backlink

Unknown interpreted text role "ref".
      
result-detail No string      
secondary-filter No

array of :ref:`secondary-filter <i_9ff0ea7437d9f1652041e3d09a47b64e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55420); backlink

Unknown interpreted text role "ref".
      
start-node-filter No

array of :ref:`start-node-filter <i_ae59734619e5707b033ddee69a8bfca9>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55420); backlink

Unknown interpreted text role "ref".
      
start-node-type No string      

Include-node-filter schema:

Secondary-filter schema:

Start-node-filter schema:

edge-tag-query-result Model Structure

Name Required Type Format Properties Description
tagged-inventory-item-list No

array of :ref:`tagged-inventory-item-list <i_e285feb80018f8ac63dec44b20e85754>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55458); backlink

Unknown interpreted text role "ref".
      

Tagged-inventory-item-list schema:

element-choice-set Model Structure

This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - TO model-element (comprises element-choice-set, One2Many) - FROM constrained-element-set (is composed of element-choice-set)

Name Required Type Format Properties Description
cardinality No string      
element-choice-set-name Yes string      
element-choice-set-uuid Yes string      
model-elements No

array of :ref:`model-elements <i_6b76f1338d485d58b2e7daab4fcf5705>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55483); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55483); backlink

Unknown interpreted text role "ref".
      
resource-version No string      

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

Duplicate explicit target name: "i_6b76f1338d485d58b2e7daab4fcf5705".

Model-elements schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

element-choice-sets Model Structure

Name Required Type Format Properties Description
element-choice-set No

array of :ref:`element-choice-sets <i_dfac5d15799975fca11bb9fd17f1aa4e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55514); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_dfac5d15799975fca11bb9fd17f1aa4e".

Element-choice-sets schema:

entitlement Model Structure

Metadata for entitlement group. ###### Related Nodes - FROM generic-vnf (is composed of entitlement) - FROM vce (is composed of entitlement)

Name Required Type Format Properties Description
group-uuid Yes string     Unique ID for the entitlement group the resource comes from, should be uuid.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55539); backlink

Unknown interpreted text role "ref".
      
resource-uuid Yes string     Unique ID of an entitlement resource.
resource-version No string     Concurrency value

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

entitlements Model Structure

Entitlements, keyed by group-uuid and resource-uuid, related to license management

Name Required Type Format Properties Description
entitlement No

array of :ref:`entitlements <i_8a45c5f1e5a8567dd5e638a39f50fa80>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55564); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_8a45c5f1e5a8567dd5e638a39f50fa80".

Entitlements schema:

esr-ems Model Structure

Persist EMS address information used by EMS driver. ###### Related Nodes - TO esr-system-info (comprises esr-ems, One2Many)

Name Required Type Format Properties Description
ems-id Yes string     Unique ID of EMS.
esr-system-info-list No

array of :ref:`esr-system-info-list <i_ec912415b8198a1e64856d6e73301049>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55588); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55588); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Esr-system-info-list schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

esr-ems-list Model Structure

Name Required Type Format Properties Description
esr-ems No

array of :ref:`esr-ems-list <i_3fccf9a85a3861b57dcc57e334339914>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55617); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_3fccf9a85a3861b57dcc57e334339914".

Esr-ems-list schema:

esr-system-info Model Structure

Persist common address information of external systems. ###### Related Nodes - FROM esr-ems (is composed of esr-system-info) - FROM esr-vnfm (is composed of esr-system-info) - FROM esr-thirdparty-sdnc (is composed of esr-system-info) - FROM cloud-region (is composed of esr-system-info)

Name Required Type Format Properties Description
cloud-domain No string     domain info for authentication.
default-tenant No string     default tenant of VIM.
esr-system-info-id Yes string     Unique ID of esr system info.
ip-address No string     service IP of ftp server.
passive No boolean     ftp passive mode or not.
password Yes string     password used to access external systems.
port No string     service port of ftp server.
protocol No string     protocol of third party SDNC, for example netconf/snmp.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55644); backlink

Unknown interpreted text role "ref".
      
remote-path No string     resource or performance data file path.
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service-url No string     url used to access external systems.
ssl-cacert No string     ca file content if enabled ssl on auth-url.
ssl-insecure No boolean     Whether to verify VIM's certificate.
system-name No string     name of external system.
system-status No string     the status of external system.
system-type Yes string     it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
type No string     type of external systems.
user-name Yes string     username used to access external systems.
vendor No string     vendor of external systems.
version No string     version of external systems.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

esr-system-info-list Model Structure

Collection of persistent block-level external system auth info.

Name Required Type Format Properties Description
esr-system-info No

array of :ref:`esr-system-info-list <i_ec912415b8198a1e64856d6e73301049>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55686); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Esr-system-info-list schema:

esr-thirdparty-sdnc Model Structure

Persist SDNC address information used by ONAP SDNC. ###### Related Nodes - TO esr-system-info (comprises esr-thirdparty-sdnc, One2One) - TO pnf (One2Many)

Name Required Type Format Properties Description
esr-system-info-list No

array of :ref:`esr-system-info-list <i_ec912415b8198a1e64856d6e73301049>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55711); backlink

Unknown interpreted text role "ref".
      
location No string     used for DC type to indicate the location of SDNC, such as Core or Edge.
product-name No string     password used to access SDNC server.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55711); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
thirdparty-sdnc-id Yes string     Unique ID of SDNC.

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

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Esr-system-info-list schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

esr-thirdparty-sdnc-list Model Structure

Name Required Type Format Properties Description
esr-thirdparty-sdnc No

array of :ref:`esr-thirdparty-sdnc-list <i_bfea90556a85d41982e7041727eb61c0>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55742); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_bfea90556a85d41982e7041727eb61c0".

Esr-thirdparty-sdnc-list schema:

esr-vnfm Model Structure

Persist VNFM address information used by VF-C. ###### Related Nodes - TO esr-system-info (comprises esr-vnfm, One2One)

Name Required Type Format Properties Description
certificate-url No string     certificate url of VNFM.
esr-system-info-list No

array of :ref:`esr-system-info-list <i_ec912415b8198a1e64856d6e73301049>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55766); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55766); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vim-id No string     indecate the VIM to deploy VNF.
vnfm-id Yes string     Unique ID of VNFM.

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

Duplicate explicit target name: "i_ec912415b8198a1e64856d6e73301049".

Esr-system-info-list schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

esr-vnfm-list Model Structure

Name Required Type Format Properties Description
esr-vnfm No

array of :ref:`esr-vnfm-list <i_ef22dc27a0c04bb57ac0f92c2fdd897c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55797); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_ef22dc27a0c04bb57ac0f92c2fdd897c".

Esr-vnfm-list schema:

external-system Model Structure

Namespace for external system.

Name Required Type Format Properties Description
esr-ems-list No

array of :ref:`esr-ems-list <i_3fccf9a85a3861b57dcc57e334339914>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55819); backlink

Unknown interpreted text role "ref".
      
esr-thirdparty-sdnc-list No

array of :ref:`esr-thirdparty-sdnc-list <i_bfea90556a85d41982e7041727eb61c0>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55819); backlink

Unknown interpreted text role "ref".
      
esr-vnfm-list No

array of :ref:`esr-vnfm-list <i_ef22dc27a0c04bb57ac0f92c2fdd897c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55819); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_3fccf9a85a3861b57dcc57e334339914".

Esr-ems-list schema:

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

Duplicate explicit target name: "i_bfea90556a85d41982e7041727eb61c0".

Esr-thirdparty-sdnc-list schema:

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

Duplicate explicit target name: "i_ef22dc27a0c04bb57ac0f92c2fdd897c".

Esr-vnfm-list schema:

extra-properties Model Structure

Extra properties for inventory item for response list

Name Required Type Format Properties Description
extra-property No

array of :ref:`extra-property <i_5e2e8714198dd79a54d3182576a63289>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55857); backlink

Unknown interpreted text role "ref".
      

Extra-property schema:

extra-property Model Structure

Name Required Type Format Properties Description
property-name No string      
property-value No string      

flavor Model Structure

Openstack flavor. ###### Related Nodes - FROM cloud-region (is composed of flavor) - FROM vserver

Name Required Type Format Properties Description
flavor-disabled No boolean     Boolean as to whether this flavor is no longer enabled
flavor-disk No integer int32   Disk space
flavor-ephemeral No integer int32   Amount of ephemeral disk space
flavor-id Yes string     Flavor id, expected to be unique across cloud-region.
flavor-is-public No boolean     whether flavor is available to all users or private to the tenant it was created in.
flavor-name Yes string     Flavor name
flavor-ram No integer int32   Amount of memory
flavor-selflink Yes string     URL to endpoint where AAI can get more details
flavor-swap No string     amount of swap space allocation
flavor-vcpus No integer int32   Number of CPUs
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55895); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

flavors Model Structure

Collection of openstack flavors.

Name Required Type Format Properties Description
flavor No

array of :ref:`flavor <i_571f5e6060c4735fc4a3a8405ac27d0d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55928); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_571f5e6060c4735fc4a3a8405ac27d0d".

Flavor schema:

generic-vnf Model Structure

General purpose VNF ###### Related Nodes - TO license-key-resource (Many2Many) - TO l-interface (comprises generic-vnf, Many2Many) - TO availability-zone (Many2Many) - TO lag-interface (comprises generic-vnf, Many2Many) - TO l3-network (Many2Many) - TO pserver (Many2Many) - TO vnf-image (Many2One) - TO vserver (One2Many) - TO service-instance (Many2Many) - TO site-pair-set (Many2Many) - TO network-profile (Many2Many) - TO pnf (Many2Many) - TO ipsec-configuration (Many2One) - TO configuration (One2Many) - TO vf-module (comprises generic-vnf, One2Many) - TO volume-group (One2Many) - TO vnfc (One2Many) - TO instance-group (Many2Many) - TO entitlement (comprises generic-vnf, One2Many) - TO license (comprises generic-vnf, One2Many) - TO complex (Many2Many) - TO ctag-pool (Many2Many) - FROM line-of-business - FROM platform - FROM virtual-data-center - FROM logical-link - FROM allotted-resource

Name Required Type Format Properties Description
as-number No string     as-number of the VNF
encrypted-access-flag No boolean     indicates whether generic-vnf access uses SSH
entitlement-assignment-group-uuid No string     UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
entitlement-resource-uuid No string     UUID of the specific entitlement resource. OBSOLETE - See child relationships.
entitlements No

array of :ref:`entitlements <i_8a45c5f1e5a8567dd5e638a39f50fa80>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55978); backlink

Unknown interpreted text role "ref".
      
equipment-role No string     Client should send valid enumerated value
heat-stack-id No string     Heat stack id corresponding to this instance, managed by MSO
in-maint Yes boolean      
ipv4-loopback0-address No string     v4 Loopback0 address
ipv4-oam-address No string     Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
ipv4-oam-gateway-address No string     Gateway address
ipv4-oam-gateway-address-prefix-length No integer int32   Prefix length for oam-address
is-closed-loop-disabled Yes boolean      
l-interfaces No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55978); backlink

Unknown interpreted text role "ref".
      
lag-interfaces No

array of :ref:`lag-interfaces <i_4e64a03bc03e2b8a1c0aceda1cd15cbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55978); backlink

Unknown interpreted text role "ref".
      
license-assignment-group-uuid No string     UUID of the license assignment group. OBSOLETE - See child relationships.
license-key No string     OBSOLETE - do not use
license-key-uuid No string     UUID of the actual license resource. OBSOLETE - See child relationships.
licenses No

array of :ref:`licenses <i_8c3e61f28428e06aef69620bca7330a3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55978); backlink

Unknown interpreted text role "ref".
      
management-option No string     identifier of managed by ATT or customer
management-v6-address No string     v6 management address
model-customization-id No string     captures the id of all the configuration used to customize the resource for the service.
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
mso-catalog-key No string     Corresponds to the SDN-C catalog id used to configure this VCE
nf-function No string     English description of Network function that the specific VNF deployment is providing
nf-naming-code No string     string assigned to this model used for naming purposes
nf-role No string     role in the network that this model will be providing
nf-type No string     Generic description of the type of NF
nm-lan-v6-address No string     v6 Loopback address
nm-profile-name No string     Network Management profile of this VNF
operational-status No string     Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
orchestration-status No string     Orchestration status of this VNF, used by MSO.
persona-model-version No string     the ASDC model version for this resource or service model.
prov-status No string     Trigger for operational monitoring of this resource by Service Assurance systems.
regional-resource-subzone No string     represents sub zone of the rr plane
regional-resource-zone No string     Regional way of organizing pservers, source of truth should define values
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55978); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
selflink No string     Path to the controller object.
service-id No string     Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
summary-status No string     details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
vcpu No integer int64   number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
vcpu-units No string     units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
vdisk No integer int64   number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
vdisk-units No string     units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
vf-modules No

array of :ref:`vf-modules <i_1bbfa7555d39dc7b7b5e7e480eb6945a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 55978); backlink

Unknown interpreted text role "ref".
      
vlan-id-outer No integer int64   Temporary location for S-TAG to get to VCE
vmemory No integer int64   number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
vmemory-units No string     units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
vnf-id Yes string     Unique id of VNF. This is unique across the graph.
vnf-name Yes string     Name of VNF.
vnf-name2 No string     Alternate name of VNF.
vnf-type Yes 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.
widget-model-id No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

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

Duplicate explicit target name: "i_8a45c5f1e5a8567dd5e638a39f50fa80".

Entitlements schema:

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

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

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

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Lag-interfaces schema:

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

Duplicate explicit target name: "i_8c3e61f28428e06aef69620bca7330a3".

Licenses schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_1bbfa7555d39dc7b7b5e7e480eb6945a".

Vf-modules schema:

generic-vnfs Model Structure

Collection of VNFs

Name Required Type Format Properties Description
generic-vnf No

array of :ref:`generic-vnf <i_06a952a9b27a806e71d90d20b21151be>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56090); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_06a952a9b27a806e71d90d20b21151be".

Generic-vnf schema:

group-assignment Model Structure

Openstack group-assignment used to store exclusivity groups (EG). ###### Related Nodes - TO tenant (Many2Many) - TO pserver (One2Many) - FROM cloud-region (is composed of group-assignment)

Name Required Type Format Properties Description
group-description No string     Group description - description of the group
group-id Yes string     Group id, expected to be unique across cloud-region.
group-name Yes string     Group name - name assigned to the group
group-type Yes string     Group type - the type of group this instance refers to
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56116); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

group-assignments Model Structure

Collection of openstack group assignments

Name Required Type Format Properties Description
group-assignment No

array of :ref:`group-assignment <i_f6c140e75861964f717c02c75fb09721>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56143); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_f6c140e75861964f717c02c75fb09721".

Group-assignment schema:

host-route Model Structure

###### Related Nodes - FROM subnet (is composed of host-route)

Name Required Type Format Properties Description
host-route-id Yes string     host-route id
next-hop Yes string     Could be ip-address, hostname, or service-instance
next-hop-type No string     Should be ip-address, hostname, or service-instance to match next-hop
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56166); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
route-prefix Yes string     subnet prefix

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

host-routes Model Structure

Name Required Type Format Properties Description
host-route No

array of :ref:`host-routes <i_34f35ddb128093303fb2b49a4e73aa29>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56190); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_34f35ddb128093303fb2b49a4e73aa29".

Host-routes schema:

image Model Structure

Openstack image. ###### Related Nodes - TO metadatum (comprises image, Many2Many) - FROM cloud-region (is composed of image) - FROM vserver

Name Required Type Format Properties Description
application No string     The application that the image instantiates.
application-vendor No string     The vendor of the application.
application-version No string     The version of the application.
image-architecture No string     Operating system architecture.
image-id Yes string     Image id, expected to be unique across cloud region
image-name Yes string     Image name
image-os-distro Yes string     The common name of the operating system distribution in lowercase
image-os-version Yes string     The operating system version as specified by the distributor.
image-selflink Yes string     URL to endpoint where AAI can get more details
metadata No

array of :ref:`metadata <i_6fb4789e41f9c692fc0616c746add31a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56216); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56216); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Metadata schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

images Model Structure

Collectio of Openstack images.

Name Required Type Format Properties Description
image No

array of :ref:`image <i_a51c24325979e69e4cfe99e2a92eae43>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56256); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_a51c24325979e69e4cfe99e2a92eae43".

Image schema:

include-node-filter Model Structure

Name Required Type Format Properties Description
include-node-type No string      

instance-filter Model Structure

InstanceFilter for performing a named-query or model query

instance-filters Model Structure

InstanceFilters for performing a named-query or model query

Name Required Type Format Properties Description
instance-filter No

array of :ref:`instance-filter <i_c708c02ad5daedd16444ce808eabfd8d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56300); backlink

Unknown interpreted text role "ref".
      

Instance-filter schema:

instance-group Model Structure

General mechanism for grouping instances ###### Related Nodes - TO model (Many2Many) - FROM l-interface - FROM vnfc - FROM l3-interface-ipv4-address-list - FROM l3-interface-ipv6-address-list - FROM l3-network - FROM pnf - FROM allotted-resource - FROM generic-vnf - FROM service-instance - FROM vip-ipv4-address-list - FROM vip-ipv6-address-list

Name Required Type Format Properties Description
description Yes string     Descriptive text to help identify the usage of this instance-group
id Yes string     Instance Group ID, UUID assigned to this instance.
instance-group-role Yes string     role of the instance group.
model-invariant-id Yes string     ASDC model id for this resource or service model.
model-version-id Yes string     ASDC model version uid for this resource model.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56335); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Concurrency value
sub-type No string     Valid values for ha type are [geo-activeactive, geo-activestandby, local-activeactive, local-activestandby]
type Yes string     Only valid value today is lower case ha for high availability

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

instance-groups Model Structure

Collection of openstack route table references

Name Required Type Format Properties Description
instance-group No

array of :ref:`instance-group <i_e76c5bd9f68a202beaf9b58a95a2792e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56365); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_e76c5bd9f68a202beaf9b58a95a2792e".

Instance-group schema:

inventory Model Structure

Name Required Type Format Properties Description
aai-internal No

:ref:`aai-internal <i_1eb3bd2ae444c17adaaf7b72e1daa0b6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
actions No

:ref:`actions <i_33bdf4dcfc7607e477b9b1ee8f21002a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
business No

:ref:`business <i_e0040e4c76c6fa94f10c8f0ddf789d0d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
cloud-infrastructure No

:ref:`cloud-infrastructure <i_9b4be4148eaa1c2b2a0d8667303094f0>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
external-system No

:ref:`external-system <i_9dfc1f8c5720d4134ff80b5c1f5fadda>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
network No

:ref:`network <i_202b181f519348fb2da4cd83897b8ef4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
nodes No

array of :ref:`nodes <i_66d9b76c5f620b8ba1f59a1a0df8057e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
search No

:ref:`search <i_bd8c64824e61985ab62cad5423a35e34>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      
service-design-and-creation No

:ref:`service-design-and-creation <i_1f84b01adcbea375bbe0af60608e663c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56384); backlink

Unknown interpreted text role "ref".
      

Aai-internal schema:

Actions schema:

Business schema:

Cloud-infrastructure schema:

External-system schema:

Network schema:

Nodes schema:

Search schema:

Service-design-and-creation schema:

inventory-item Model Structure

Name Required Type Format Properties Description
inventory-item-data No

array of :ref:`inventory-item-data <i_72522ea8c5ec025fd1183e1c89623115>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56467); backlink

Unknown interpreted text role "ref".
      
inventory-item-link No string      
inventory-item-type No string      
tagged-inventory-item-list No

array of :ref:`tagged-inventory-item-list <i_e285feb80018f8ac63dec44b20e85754>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56467); backlink

Unknown interpreted text role "ref".
      

Inventory-item-data schema:

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

Duplicate explicit target name: "i_e285feb80018f8ac63dec44b20e85754".

Tagged-inventory-item-list schema:

inventory-item-data Model Structure

Name Required Type Format Properties Description
property-name No string      
property-value No string      

inventory-response-item Model Structure

Inventory item for response list

Name Required Type Format Properties Description
extra-properties No

:ref:`extra-properties <i_0d83b32594ac37b1fbc6bfa8ffbd750d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56512); backlink

Unknown interpreted text role "ref".
      
inventory-response-items No

:ref:`inventory-response-items <i_4fb91835eef824be5135a1a48e29395d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56512); backlink

Unknown interpreted text role "ref".
      
model-name No string      

Extra-properties schema:

Inventory-response-items schema:

inventory-response-items Model Structure

Container for inventory items in response list

Name Required Type Format Properties Description
inventory-response-item No

array of :ref:`inventory-response-item <i_8bf6b8ba6ae11df39537ecd5182d7680>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56543); backlink

Unknown interpreted text role "ref".
      

Inventory-response-item schema:

ipsec-configuration Model Structure

IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C ###### Related Nodes - TO vig-server (comprises ipsec-configuration, One2Many) - FROM generic-vnf

Name Required Type Format Properties Description
dpd-frequency No string     Maximum number of DPD before claiming the tunnel is down
dpd-interval No string     The time between DPD probe
ike-version No string     can be 1 or 2
ikev1-am-group-id No string     Group name defined in VIG for clients using aggressive mode
ikev1-am-password No string     pre-shared key for the above group name
ikev1-authentication No string     Contains values like md5, sha1, sha256, sha384
ikev1-dh-group No string     Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
ikev1-encryption No string     Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
ikev1-sa-lifetime No string     Lifetime for IKEv1 SA
ipsec-authentication No string     md5, sha1, sha256, sha384
ipsec-configuration-id Yes string     UUID of this configuration
ipsec-encryption No string     3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
ipsec-pfs No string     enable PFS or not
ipsec-sa-lifetime No string     Life time for IPSec SA
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56568); backlink

Unknown interpreted text role "ref".
      
requested-customer-name No string     If the DMZ is a custom DMZ, this field will indicate the customer information
requested-dmz-type No string     ATT can offer a shared DMZ or a DMZ specific to a customer
requested-encryption-strength No string     Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
requested-vig-address-type No string     Indicate the type of VIG server like AVPN, INTERNET, BOTH
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
shared-dmz-network-address No string     Network address of shared DMZ
vig-servers No

array of :ref:`vig-servers <i_59ca4cf5d26601abaafb921421316d97>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56568); backlink

Unknown interpreted text role "ref".
      
xauth-user-password No string     Encrypted using the Juniper $9$ algorithm
xauth-userid No string     user ID for xAuth, sm-user,ucpeHostName,nmteHostName

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_59ca4cf5d26601abaafb921421316d97".

Vig-servers schema:

ipsec-configurations Model Structure

Name Required Type Format Properties Description
ipsec-configuration No

array of :ref:`ipsec-configurations <i_04d523902534cf61e268a9c9a42b7212>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56617); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_04d523902534cf61e268a9c9a42b7212".

Ipsec-configurations schema:

key-data Model Structure

Name Required Type Format Properties Description
key-name No string      
key-value No string      

l-interface Model Structure

Logical interfaces, e.g., a vnic. ###### Related Nodes - TO instance-group (Many2Many) - TO l3-interface-ipv4-address-list (comprises l-interface, Many2Many) - TO l3-interface-ipv6-address-list (comprises l-interface, Many2Many) - TO l-interface (comprises l-interface, One2Many) - TO logical-link (Many2Many) - TO vlan (comprises l-interface, Many2Many) - TO sriov-vf (comprises l-interface, One2One) - FROM generic-vnf (is composed of l-interface) - FROM lag-interface (is composed of l-interface) - FROM newvce (is composed of l-interface) - FROM p-interface (is composed of l-interface) - FROM vserver (is composed of l-interface) - FROM allotted-resource - FROM l-interface (is composed of l-interface)

Name Required Type Format Properties Description
allowed-address-pairs No string     Freeform field for storing an ip address, list of ip addresses or a subnet block.
in-maint Yes boolean      
interface-description No string     Human friendly text regarding this interface.
interface-id No string     ID of interface
interface-name Yes string     Name given to the interface
interface-role No string     E.g., CUSTOMER, UPLINK, etc.
is-ip-unnumbered Yes boolean      
is-port-mirrored Yes boolean      
l-interfaces No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56667); backlink

Unknown interpreted text role "ref".
      
l3-interface-ipv4-address-list No

array of :ref:`l3-interface-ipv4-address-list <i_bb0ca453b6a655cf421cc9c3f96bd80e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56667); backlink

Unknown interpreted text role "ref".
      
l3-interface-ipv6-address-list No

array of :ref:`l3-interface-ipv6-address-list <i_a6687b71c19d62d1985bf4722dc089f7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56667); backlink

Unknown interpreted text role "ref".
      
macaddr No string     MAC address for the interface
management-option No string     Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
network-name No string     Name of the network
prov-status No string     Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56667); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
selflink No string     URL to endpoint where AAI can get more details
sriov-vfs No

array of :ref:`sriov-vf <i_282ce4c9acf1768d31303341d6d02da3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56667); backlink

Unknown interpreted text role "ref".
      
v6-wan-link-ip No string     Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
vlans No

array of :ref:`vlan <i_cf1c1ccb983fcd9fcd0b31440ada9380>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56667); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

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

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

L3-interface-ipv4-address-list schema:

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

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

L3-interface-ipv6-address-list schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Sriov-vf schema:

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

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Vlan schema:

l-interfaces Model Structure

Collection of logical interfaces.

Name Required Type Format Properties Description
l-interface No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56744); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

l3-interface-ipv4-address-list Model Structure

IPv4 Address Range ###### Related Nodes - TO instance-group (Many2Many) - TO l3-network (Many2Many) - TO subnet (Many2Many) - TO vnfc (is composed of l3-interface-ipv4-address-list, Many2One) - FROM l-interface (is composed of l3-interface-ipv4-address-list) - FROM vlan (is composed of l3-interface-ipv4-address-list)

Name Required Type Format Properties Description
is-floating No boolean     Indicator of fixed or floating address
l3-interface-ipv4-address Yes string     IP address
l3-interface-ipv4-prefix-length No integer int64   Prefix length, 32 for single address
neutron-network-id No string     Neutron network id of the interface that address belongs to
neutron-subnet-id No string     Neutron id of subnet that address belongs to
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56773); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vlan-id-inner No integer int64   Inner VLAN tag
vlan-id-outer No integer int64   Outer VLAN tag

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

l3-interface-ipv6-address-list Model Structure

IPv6 Address Range ###### Related Nodes - TO instance-group (Many2Many) - TO l3-network (Many2Many) - TO subnet (Many2Many) - TO vnfc (is composed of l3-interface-ipv6-address-list, Many2One) - FROM l-interface (is composed of l3-interface-ipv6-address-list) - FROM vlan (is composed of l3-interface-ipv6-address-list)

Name Required Type Format Properties Description
is-floating No boolean     Indicator of fixed or floating address
l3-interface-ipv6-address Yes string     IP address
l3-interface-ipv6-prefix-length No integer int64   Prefix length, 128 for single address
neutron-network-id No string     Neutron network id of the interface that address belongs to
neutron-subnet-id No string     Neutron id of subnet that address belongs to
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56810); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vlan-id-inner No integer int64   Inner VLAN tag
vlan-id-outer No integer int64   Outer VLAN tag

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

l3-network Model Structure

Generic network definition ###### Related Nodes - TO vpn-binding (Many2Many) - TO instance-group (Many2Many) - TO subnet (comprises l3-network, Many2Many) - TO service-instance (Many2Many) - TO ctag-assignment (comprises l3-network, Many2Many) - TO network-policy (Many2Many) - TO segmentation-assignment (comprises l3-network, One2Many) - TO route-table-reference (Many2Many) - FROM cloud-region - FROM complex - FROM generic-vnf - FROM l3-interface-ipv4-address-list - FROM l3-interface-ipv6-address-list - FROM tenant - FROM vf-module - FROM allotted-resource

Name Required Type Format Properties Description
contrail-network-fqdn No string     Contrail FQDN for the network
ctag-assignments No

array of :ref:`ctag-assignment <i_de1d81a4a65ccede72c9ef3492c31014>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56857); backlink

Unknown interpreted text role "ref".
      
heat-stack-id No string     Heat stack id corresponding to this instance, managed by MSO
is-bound-to-vpn Yes boolean      
is-external-network Yes boolean      
is-provider-network Yes boolean      
is-shared-network Yes boolean      
model-customization-id No string     captures the id of all the configuration used to customize the resource for the service.
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
mso-catalog-key No string     Corresponds to the SDN-C catalog id used to configure this VCE
network-id Yes string     Network ID, should be uuid. Unique across A&AI.
network-name Yes string     Name of the network, governed by some naming convention..
network-role No string     Role the network plans - who defines these values?
network-role-instance No integer int64   network role instance
network-technology No string     Network technology - who defines these values?
network-type No string     Type of the network - who defines these values?
neutron-network-id No string     Neutron network id of this Interface
operational-status No string     Indicator for whether the resource is considered operational.
orchestration-status No string     Orchestration status of this VNF, mastered by MSO
persona-model-version No string     the ASDC model version for this resource or service model.
physical-network-name No string     Name associated with the physical network.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56857); backlink

Unknown interpreted text role "ref".
     Relates to tenant (or is it a child of tenant), complex, service, vpn-binding
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
segmentation-assignments No

array of :ref:`segmentation-assignment <i_e3d1acc678a798310c1372b634684d81>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56857); backlink

Unknown interpreted text role "ref".
      
selflink No string     Path to the controller object.
service-id No string     Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
subnets No

array of :ref:`subnets <i_66c5ac4d2c517349c9b71c59a5247423>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56857); backlink

Unknown interpreted text role "ref".
      
widget-model-id No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

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

Duplicate explicit target name: "i_de1d81a4a65ccede72c9ef3492c31014".

Ctag-assignment schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

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

Duplicate explicit target name: "i_e3d1acc678a798310c1372b634684d81".

Segmentation-assignment schema:

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

Duplicate explicit target name: "i_66c5ac4d2c517349c9b71c59a5247423".

Subnets schema:

l3-networks Model Structure

Name Required Type Format Properties Description
l3-network No

array of :ref:`l3-networks <i_f87f7544b5e2f8cd20c6cce13c8db09a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56926); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_f87f7544b5e2f8cd20c6cce13c8db09a".

L3-networks schema:

lag-interface Model Structure

Link aggregate interface ###### Related Nodes - TO logical-link (Many2Many) - TO lag-link (Many2Many) - TO p-interface (Many2Many) - TO l-interface (comprises lag-interface, Many2Many) - FROM generic-vnf (is composed of lag-interface) - FROM pserver (is composed of lag-interface) - FROM pnf (is composed of lag-interface) - FROM vpls-pe (is composed of lag-interface)

Name Required Type Format Properties Description
in-maint Yes boolean      
interface-description No string     Human friendly text regarding this interface.
interface-id No string     ID of interface
interface-name Yes string     Name that identifies the link aggregate interface
interface-role No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
l-interfaces No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56957); backlink

Unknown interpreted text role "ref".
      
prov-status No string     Trigger for operational monitoring of this resource by Service Assurance systems.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56957); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
speed-units No string     Captures the units corresponding to the speed
speed-value No string     Captures the numeric part of the speed

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

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

lag-interfaces Model Structure

Collection of link aggregate interfaces.

Name Required Type Format Properties Description
lag-interface No

array of :ref:`lag-interfaces <i_4e64a03bc03e2b8a1c0aceda1cd15cbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 56996); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Lag-interfaces schema:

license Model Structure

Metadata for license group. ###### Related Nodes - FROM generic-vnf (is composed of license) - FROM vce (is composed of license)

Name Required Type Format Properties Description
group-uuid Yes string     Unique ID for the license group the resource belongs to, should be uuid.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57070); backlink

Unknown interpreted text role "ref".
      
resource-uuid Yes string     Unique ID of a license resource.
resource-version No string     Concurrency value

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

licenses Model Structure

Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management

Name Required Type Format Properties Description
license No

array of :ref:`licenses <i_8c3e61f28428e06aef69620bca7330a3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57095); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_8c3e61f28428e06aef69620bca7330a3".

Licenses schema:

line-of-business Model Structure

describes a line-of-business ###### Related Nodes - TO generic-vnf (Many2Many)

Name Required Type Format Properties Description
line-of-business-name Yes string     Name of the line-of-business (product)
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57119); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

lines-of-business Model Structure

Collection of lines-of-business

Name Required Type Format Properties Description
line-of-business No

array of :ref:`lines-of-business <i_4c9a2ed440bf1a52cb5c6f554b57c866>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57143); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_4c9a2ed440bf1a52cb5c6f554b57c866".

Lines-of-business schema:

metadata Model Structure

Collection of metadatum (key/value pairs)

Name Required Type Format Properties Description
metadatum No

array of :ref:`metadata <i_6fb4789e41f9c692fc0616c746add31a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57245); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Metadata schema:

metadatum Model Structure

Key/value pairs ###### Related Nodes - FROM configuration (is composed of metadatum) - FROM image (is composed of metadatum) - FROM model-ver (is composed of metadatum) - FROM service-instance (is composed of metadatum) - FROM connector (is composed of metadatum)

Name Required Type Format Properties Description
metaname Yes string      
metaval Yes string      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

model Model Structure

Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version ###### Related Nodes - TO model-ver (comprises model, One2Many) - FROM named-query - FROM named-query-element - FROM instance-group

Name Required Type Format Properties Description
model-invariant-id Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-type Yes string     Type of the model, e.g., service, resource, widget, etc.
model-vers No

array of :ref:`model-vers <i_9171944339ceb27c07d127d2245a8af5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57295); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57295); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_9171944339ceb27c07d127d2245a8af5".

Model-vers schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

model-and-named-query-search Model Structure

ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query

Name Required Type Format Properties Description
instance-filters No

:ref:`instance-filters <i_e97d74733d5b681b020ef833c09693ab>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57328); backlink

Unknown interpreted text role "ref".
      
query-parameters No

:ref:`query-parameters <i_9ff87d0c4a0ac9268754fd4ef17ae1c5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57328); backlink

Unknown interpreted text role "ref".
      
secondary-filter-cut-point No string      
secondary-filts No

:ref:`secondary-filts <i_3e1bd84fa810426794b0adc24ed07915>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57328); backlink

Unknown interpreted text role "ref".
      
top-node-type No string      

Instance-filters schema:

Query-parameters schema:

Secondary-filts schema:

model-constraint Model Structure

This is how we would capture constraints defining allowed sets of elements. ###### Related Nodes - TO constrained-element-set (comprises model-constraint, One2Many) - FROM model-element (is composed of model-constraint)

Name Required Type Format Properties Description
constrained-element-set-uuid-to-replace Yes string      
constrained-element-sets No

array of :ref:`constrained-element-sets <i_a7dd9ea3d17271f7b74122224690347f>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57371); backlink

Unknown interpreted text role "ref".
      
model-constraint-uuid Yes string      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_a7dd9ea3d17271f7b74122224690347f".

Constrained-element-sets schema:

model-constraints Model Structure

Name Required Type Format Properties Description
model-constraint No

array of :ref:`model-constraint <i_7e698f4048064278327d70b0e968c2da>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57393); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_7e698f4048064278327d70b0e968c2da".

Model-constraint schema:

model-element Model Structure

Defines how other models combine to make up a higher-level model. ###### Related Nodes - TO model-ver (Many2One) - TO model-element (comprises model-element, One2Many) - TO model-constraint (comprises model-element, One2Many) - TO constrained-element-set (comprises model-element, One2Many) - FROM model-ver (is composed of model-element) - FROM element-choice-set (is composed of model-element) - FROM model-element (is composed of model-element)

Name Required Type Format Properties Description
cardinality Yes string     How many of this type of element are required/allowed
linkage-points No string      
model-constraints No

array of :ref:`model-constraint <i_7e698f4048064278327d70b0e968c2da>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57423); backlink

Unknown interpreted text role "ref".
     Describes new constraints on this model element that are not part of that model's definition
model-element-uuid Yes string      
model-elements No

array of :ref:`model-elements <i_6b76f1338d485d58b2e7daab4fcf5705>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57423); backlink

Unknown interpreted text role "ref".
     Defines how other models combine to make up a higher-level model
new-data-del-flag Yes string     Indicates whether this element was created as part of instantiation from this model
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57423); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_7e698f4048064278327d70b0e968c2da".

Model-constraint schema:

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

Duplicate explicit target name: "i_6b76f1338d485d58b2e7daab4fcf5705".

Model-elements schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

model-elements Model Structure

Name Required Type Format Properties Description
model-element No

array of :ref:`model-elements <i_6b76f1338d485d58b2e7daab4fcf5705>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57463); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_6b76f1338d485d58b2e7daab4fcf5705".

Model-elements schema:

model-ver Model Structure

Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models ###### Related Nodes - TO model-element (comprises model-ver, One2Many) - TO metadatum (comprises model-ver, One2Many) - FROM model (is composed of model-ver) - FROM model-element

Name Required Type Format Properties Description
metadata No

array of :ref:`metadata <i_6fb4789e41f9c692fc0616c746add31a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57490); backlink

Unknown interpreted text role "ref".
      
model-description No string     Description
model-elements No

array of :ref:`model-elements <i_6b76f1338d485d58b2e7daab4fcf5705>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57490); backlink

Unknown interpreted text role "ref".
      
model-name Yes string     Name of the model, which can change from version to version.
model-version Yes string     Version
model-version-id Yes string     Unique identifier corresponding to one version of a model in ASDC
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57490); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

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

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Metadata schema:

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

Duplicate explicit target name: "i_6b76f1338d485d58b2e7daab4fcf5705".

Model-elements schema:

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

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

model-vers Model Structure

Name Required Type Format Properties Description
model-ver No

array of :ref:`model-vers <i_9171944339ceb27c07d127d2245a8af5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57530); backlink

Unknown interpreted text role "ref".
      

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

Duplicate explicit target name: "i_9171944339ceb27c07d127d2245a8af5".

Model-vers schema:

models Model Structure

Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models

Name Required Type Format Properties Description
model No

array of :ref:`models <i_41777cd8804da9ec90bd3c37d52921e6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57552); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57554); backlink

Duplicate explicit target name: "i_41777cd8804da9ec90bd3c37d52921e6".

Models schema:

multicast-configuration Model Structure

###### Related Nodes - FROM vlan

Name Required Type Format Properties Description
multicast-configuration-id Yes string     Unique id of multicast configuration.
multicast-protocol Yes string     protocol of multicast configuration
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57575); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
rp-type Yes string     rp type of multicast configuration

System Message: WARNING/2 (aai_swagger_v11.rst, line 57581); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

multicast-configurations Model Structure

multicast configuration of generic-vnf ip-address

Name Required Type Format Properties Description
multicast-configuration No

array of :ref:`multicast-configurations <i_92e93ffdd62377ab9dc3fffbc862167c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57601); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57603); backlink

Duplicate explicit target name: "i_92e93ffdd62377ab9dc3fffbc862167c".

Multicast-configurations schema:

named-queries Model Structure

Name Required Type Format Properties Description
named-query No

array of :ref:`named-query <i_fc6cb4831a97be8ac00f8f7dc7cc479e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57620); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57622); backlink

Duplicate explicit target name: "i_fc6cb4831a97be8ac00f8f7dc7cc479e".

Named-query schema:

named-query Model Structure

TBD ###### Related Nodes - TO model (One2Many) - TO named-query-element (comprises named-query, One2One)

Name Required Type Format Properties Description
description No string      
named-query-elements No

array of :ref:`named-query-element <i_8380f69635d0e9fe0bf3bfa08e1c824b>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57645); backlink

Unknown interpreted text role "ref".
      
named-query-name Yes string      
named-query-uuid Yes string      
named-query-version Yes string      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57645); backlink

Unknown interpreted text role "ref".
      
required-input-param No string      
resource-version No string      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57654); backlink

Duplicate explicit target name: "i_8380f69635d0e9fe0bf3bfa08e1c824b".

Named-query-element schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57661); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

named-query-element Model Structure

TBD ###### Related Nodes - TO named-query-element (comprises named-query-element, Many2Many) - TO model (Many2One) - TO property-constraint (comprises named-query-element, One2Many) - TO related-lookup (comprises named-query-element, One2Many) - FROM named-query (is composed of named-query-element) - FROM named-query-element (is composed of named-query-element)

Name Required Type Format Properties Description
do-not-output No string      
named-query-element-uuid Yes string      
named-query-elements No

array of :ref:`named-query-element <i_8380f69635d0e9fe0bf3bfa08e1c824b>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57688); backlink

Unknown interpreted text role "ref".
      
property-collect-list No string      
property-constraints No

array of :ref:`property-constraint <i_0ae597bc5f078bbe4b4bf13aa13dd7c5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57688); backlink

Unknown interpreted text role "ref".
      
property-limit-desc No string      
related-lookups No

array of :ref:`related-lookup <i_d597d36ede6f649a5a246def3016f836>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57688); backlink

Unknown interpreted text role "ref".
      
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57688); backlink

Unknown interpreted text role "ref".
      
resource-version No string      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57698); backlink

Duplicate explicit target name: "i_8380f69635d0e9fe0bf3bfa08e1c824b".

Named-query-element schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57705); backlink

Duplicate explicit target name: "i_0ae597bc5f078bbe4b4bf13aa13dd7c5".

Property-constraint schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57712); backlink

Duplicate explicit target name: "i_d597d36ede6f649a5a246def3016f836".

Related-lookup schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57719); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

named-query-elements Model Structure

Name Required Type Format Properties Description
named-query-element No

array of :ref:`named-query-element <i_8380f69635d0e9fe0bf3bfa08e1c824b>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57736); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57738); backlink

Duplicate explicit target name: "i_8380f69635d0e9fe0bf3bfa08e1c824b".

Named-query-element schema:

network Model Structure

Namespace for network inventory resources.

Name Required Type Format Properties Description
generic-vnfs No

array of :ref:`generic-vnf <i_06a952a9b27a806e71d90d20b21151be>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
instance-groups No

array of :ref:`instance-group <i_e76c5bd9f68a202beaf9b58a95a2792e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
ipsec-configurations No

array of :ref:`ipsec-configurations <i_04d523902534cf61e268a9c9a42b7212>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
l3-networks No

array of :ref:`l3-networks <i_f87f7544b5e2f8cd20c6cce13c8db09a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
lag-links No

array of :ref:`lag-links <i_8748a2dfe6d86e203874ce9301d85cd4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
logical-links No

array of :ref:`logical-link <i_2582488ed050f82543c35118db22c409>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
multicast-configurations No

array of :ref:`multicast-configurations <i_92e93ffdd62377ab9dc3fffbc862167c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
network-policies No

array of :ref:`network-policies <i_fd26db9a2279dd3fbcaf00406fe86ec6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
newvces No

array of :ref:`newvces <i_f65011c27139f53b2910e64160d36358>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
physical-links No

array of :ref:`physical-links <i_a13a8e42790da6623781f923ee61f416>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
pnfs No

array of :ref:`pnfs <i_bc74f61831453678365f7383ad6ca04e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
route-table-references No

array of :ref:`route-table-references <i_6c59bd944f0e253bb650f63c9e4dd834>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
site-pair-sets No

array of :ref:`site-pair-sets <i_675943dd0433645a183553fd21389c81>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
vces No

array of :ref:`vces <i_f28accb396e15e371eb59af79a5dbe5a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
vnfcs No

array of :ref:`vnfc <i_120d1487fd3ba7687158894ca473218c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
vpls-pes No

array of :ref:`vpls-pes <i_b7200ee27877b16bc58e6ed01696c38c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
vpn-bindings No

array of :ref:`vpn-binding <i_9748245f68da65b38b1103b9df0fd5b4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      
zones No

array of :ref:`zone <i_b071e942df8c17072bdd019656cdefbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57758); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57777); backlink

Duplicate explicit target name: "i_06a952a9b27a806e71d90d20b21151be".

Generic-vnf schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57784); backlink

Duplicate explicit target name: "i_e76c5bd9f68a202beaf9b58a95a2792e".

Instance-group schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57791); backlink

Duplicate explicit target name: "i_04d523902534cf61e268a9c9a42b7212".

Ipsec-configurations schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57798); backlink

Duplicate explicit target name: "i_f87f7544b5e2f8cd20c6cce13c8db09a".

L3-networks schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57805); backlink

Duplicate explicit target name: "i_8748a2dfe6d86e203874ce9301d85cd4".

Lag-links schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57812); backlink

Duplicate explicit target name: "i_2582488ed050f82543c35118db22c409".

Logical-link schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57819); backlink

Duplicate explicit target name: "i_92e93ffdd62377ab9dc3fffbc862167c".

Multicast-configurations schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57826); backlink

Duplicate explicit target name: "i_fd26db9a2279dd3fbcaf00406fe86ec6".

Network-policies schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57833); backlink

Duplicate explicit target name: "i_f65011c27139f53b2910e64160d36358".

Newvces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57840); backlink

Duplicate explicit target name: "i_a13a8e42790da6623781f923ee61f416".

Physical-links schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57847); backlink

Duplicate explicit target name: "i_bc74f61831453678365f7383ad6ca04e".

Pnfs schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57854); backlink

Duplicate explicit target name: "i_6c59bd944f0e253bb650f63c9e4dd834".

Route-table-references schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57861); backlink

Duplicate explicit target name: "i_675943dd0433645a183553fd21389c81".

Site-pair-sets schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57868); backlink

Duplicate explicit target name: "i_f28accb396e15e371eb59af79a5dbe5a".

Vces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57875); backlink

Duplicate explicit target name: "i_120d1487fd3ba7687158894ca473218c".

Vnfc schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57882); backlink

Duplicate explicit target name: "i_b7200ee27877b16bc58e6ed01696c38c".

Vpls-pes schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57889); backlink

Duplicate explicit target name: "i_9748245f68da65b38b1103b9df0fd5b4".

Vpn-binding schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 57896); backlink

Duplicate explicit target name: "i_b071e942df8c17072bdd019656cdefbc".

Zone schema:

network-policies Model Structure

Name Required Type Format Properties Description
network-policy No

array of :ref:`network-policies <i_fd26db9a2279dd3fbcaf00406fe86ec6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57913); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57915); backlink

Duplicate explicit target name: "i_fd26db9a2279dd3fbcaf00406fe86ec6".

Network-policies schema:

network-policy Model Structure

###### Related Nodes - FROM l3-network - FROM allotted-resource

Name Required Type Format Properties Description
heat-stack-id No string     ID for the openStack Heat instance
network-policy-fqdn No string     Contrail FQDN for the policy
network-policy-id Yes string     UUID representing unique key to this instance
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57937); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 57943); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

network-profile Model Structure

Network profile populated by SDN-GP for SNMP ###### Related Nodes - FROM generic-vnf

Name Required Type Format Properties Description
community-string No string     Encrypted SNMP community string
nm-profile-name Yes string     Unique name of network profile.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57965); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 57970); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

network-profiles Model Structure

Collection of network profiles

Name Required Type Format Properties Description
network-profile No

array of :ref:`network-profile <i_a50e1b79cd43e4089afc53d6a882521a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 57990); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 57992); backlink

Duplicate explicit target name: "i_a50e1b79cd43e4089afc53d6a882521a".

Network-profile schema:

newvce Model Structure

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce. ###### Related Nodes - TO l-interface (comprises newvce, Many2Many)

Name Required Type Format Properties Description
equipment-role No string     Client should send valid enumerated value.
heat-stack-id No string     Heat stack id corresponding to this instance, managed by MSO
ipv4-loopback0-address No string     v4 Loopback0 address
ipv4-oam-address No string     Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
l-interfaces No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58014); backlink

Unknown interpreted text role "ref".
      
license-key No string     OBSOLETE - do not use
mso-catalog-key No string     Corresponds to the SDN-C catalog id used to configure this VCE
operational-status No string     Indicator for whether the resource is considered operational
orchestration-status No string     Orchestration status of this VNF, mastered by MSO.
prov-status No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58014); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vnf-id2 Yes string     Unique id of VNF, can't use same attribute name right now until we promote this new object
vnf-name Yes string     Name of VNF.
vnf-name2 No string     Alternate name of VNF.
vnf-type Yes 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.

System Message: WARNING/2 (aai_swagger_v11.rst, line 58031); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58038); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

newvces Model Structure

This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.

Name Required Type Format Properties Description
newvce No

array of :ref:`newvces <i_f65011c27139f53b2910e64160d36358>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58058); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58060); backlink

Duplicate explicit target name: "i_f65011c27139f53b2910e64160d36358".

Newvces schema:

notification-event Model Structure

Name Required Type Format Properties Description
cambria.partition No string      
notification-event-header No

:ref:`notification-event-header <i_b787a3608e5e65dabd04e63a0d8ade5c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58077); backlink

Unknown interpreted text role "ref".
      

Notification-event-header schema:

notification-event-header Model Structure

Name Required Type Format Properties Description
action No string      
domain No string      
entity-link No string      
entity-type No string      
event-type No string      
id No string      
sequence-number No string      
severity No string      
source-name No string      
status No string      
timestamp No string      
top-entity-type No string      
version No string      

notify Model Structure

Name Required Type Format Properties Description
event-id Yes string      
event-trigger No string      
key-data No

array of :ref:`key-data <i_1c6d64b72738dc3464e6ac96ba19b49d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58121); backlink

Unknown interpreted text role "ref".
      
node-type No string      
selflink No string      

Key-data schema:

oam-network Model Structure

OAM network, to be deprecated shortly. Do not use for new purposes. ###### Related Nodes - TO complex (Many2Many) - TO service-capability (Many2Many) - FROM cloud-region (is composed of oam-network)

Name Required Type Format Properties Description
cvlan-tag Yes integer int64   cvlan-id
ipv4-oam-gateway-address No string     Used for VNF firewall rule so customer cannot send customer traffic over this oam network
ipv4-oam-gateway-address-prefix-length No integer int32   Used for VNF firewall rule so customer cannot send customer traffic over this oam network
network-name Yes string     Name of the network.
network-uuid Yes string     UUID of the network. Unique across a cloud-region
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58151); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 58159); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

oam-networks Model Structure

Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.

Name Required Type Format Properties Description
oam-network No

array of :ref:`oam-network <i_1e18de35af33a443b1075762d99f74ca>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58179); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58181); backlink

Duplicate explicit target name: "i_1e18de35af33a443b1075762d99f74ca".

Oam-network schema:

overloaded-model Model Structure

Allows for legacy POST of old-style and new-style models

Name Required Type Format Properties Description
model-description No string     Description
model-id Yes string     Invariant unique ID which does not change from version to version
model-invariant-id Yes string     Unique identifier corresponding to the main definition of a model in ASDC
model-name Yes string     Name of the model, which can change from version to version.
model-name-version-id Yes string     Unique identifier corresponding to one version of a model in ASDC
model-type Yes string     Type of the model, e.g., service, resource, widget, etc.
model-vers No

:ref:`model-vers <i_5c501783de435f73011dd4af2501e2d2>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58201); backlink

Unknown interpreted text role "ref".
      
model-version Yes string     Version
relationship-list No

:ref:`relationship-list <i_843e57e113524c26549cec942567cde2>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58201); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

Model-vers schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58219); backlink

Duplicate explicit target name: "i_843e57e113524c26549cec942567cde2".

Relationship-list schema:

owning-entities Model Structure

Collection of owning-entities

Name Required Type Format Properties Description
owning-entity No

array of :ref:`owning-entities <i_2d49ced111ed3ef9a5e3f7d84059b8e2>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58239); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58241); backlink

Duplicate explicit target name: "i_2d49ced111ed3ef9a5e3f7d84059b8e2".

Owning-entities schema:

owning-entity Model Structure

describes an owning-entity ###### Related Nodes - TO service-instance (One2Many)

Name Required Type Format Properties Description
owning-entity-id Yes string     UUID of an owning entity
owning-entity-name Yes string     Owning entity name
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58263); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 58268); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

p-interface Model Structure

Physical interface (e.g., nic) ###### Related Nodes - TO l-interface (comprises p-interface, Many2Many) - TO physical-link (Many2Many) - TO logical-link (Many2One) - TO sriov-pf (comprises p-interface, One2One) - FROM lag-interface - FROM pserver (is composed of p-interface) - FROM pnf (is composed of p-interface) - FROM vpls-pe (is composed of p-interface)

Name Required Type Format Properties Description
equipment-identifier No string     CLEI or other specification for p-interface hardware.
in-maint Yes boolean      
interface-name Yes string     Name that identifies the physical interface
interface-role No string     Role specification for p-interface hardware.
interface-type No string     Indicates the physical properties of the interface.
inv-status No string     inventory status
l-interfaces No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58297); backlink

Unknown interpreted text role "ref".
      
mac-addresss No string     MAC Address of the p-interface.
port-description No string     Nature of the services and connectivity on this port.
prov-status No string     Trigger for operational monitoring of this resource by Service Assurance systems.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58297); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
speed-units No string     Captures the units corresponding to the speed
speed-value No string     Captures the numeric part of the speed
sriov-pfs No

array of :ref:`sriov-pfs <i_b3470e561b5aa9542bf8ac5c2064c738>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58297); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58313); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58320); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58327); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Sriov-pfs schema:

p-interfaces Model Structure

Collection of physical interfaces.

Name Required Type Format Properties Description
p-interface No

array of :ref:`p-interfaces <i_fff47b229d67b773a7fd59e4ded9c57e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58347); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58349); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

P-interfaces schema:

platform Model Structure

describes a platform ###### Related Nodes - TO generic-vnf (Many2Many)

Name Required Type Format Properties Description
platform-name Yes string     Name of the platform
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58429); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 58433); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

platforms Model Structure

Collection of platforms

Name Required Type Format Properties Description
platform No

array of :ref:`platform <i_bbf1456f16dc4f9e3f0edfb0db178ae4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58453); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58455); backlink

Duplicate explicit target name: "i_bbf1456f16dc4f9e3f0edfb0db178ae4".

Platform schema:

pnf Model Structure

PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE. ###### Related Nodes - TO p-interface (comprises pnf, Many2Many) - TO lag-interface (comprises pnf, One2Many) - TO complex (Many2One) - TO instance-group (Many2Many) - TO zone (Many2One) - FROM esr-thirdparty-sdnc - FROM generic-vnf - FROM logical-link - FROM service-instance

Name Required Type Format Properties Description
equip-model No string     Equipment model. Source of truth should define valid values.
equip-type No string     Equipment type. Source of truth should define valid values.
equip-vendor No string     Equipment vendor. Source of truth should define valid values.
frame-id No string     ID of the physical frame (relay rack) where pnf is installed.
in-maint Yes boolean      
inv-status No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
ipaddress-v4-aim No string     IPV4 AIM address
ipaddress-v4-loopback-0 No string     IPV4 Loopback 0 address
ipaddress-v4-oam No string     ipv4-oam-address with new naming convention for IP addresses
ipaddress-v6-aim No string     IPV6 AIM address
ipaddress-v6-loopback-0 No string     IPV6 Loopback 0 address
ipaddress-v6-oam No string     IPV6 OAM address
lag-interfaces No

array of :ref:`lag-interfaces <i_4e64a03bc03e2b8a1c0aceda1cd15cbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58485); backlink

Unknown interpreted text role "ref".
      
management-option No string     identifier of managed by ATT or customer
nf-role No string     Nf Role is the role performed by this instance in the network.
p-interfaces No

array of :ref:`p-interfaces <i_fff47b229d67b773a7fd59e4ded9c57e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58485); backlink

Unknown interpreted text role "ref".
      
pnf-id No string     id of pnf
pnf-name Yes string     unique name of Physical Network Function.
pnf-name2 No string     name of Physical Network Function.
pnf-name2-source No string     source of name2
prov-status No string     Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58485); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
serial-number No string     Serial number of the device
sw-version No string     sw-version is the version of SW for the hosted application on the PNF.

System Message: WARNING/2 (aai_swagger_v11.rst, line 58511); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Lag-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58518); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

P-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58525); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

pnfs Model Structure

Collection of Physical Network Functions.

Name Required Type Format Properties Description
pnf No

array of :ref:`pnfs <i_bc74f61831453678365f7383ad6ca04e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58545); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58547); backlink

Duplicate explicit target name: "i_bc74f61831453678365f7383ad6ca04e".

Pnfs schema:

port-group Model Structure

Used to capture the network interfaces of this VCE ###### Related Nodes - TO cvlan-tag (comprises port-group, Many2Many) - FROM vce (is composed of port-group)

Name Required Type Format Properties Description
cvlan-tags No

array of :ref:`cvlan-tag-entry <i_a144c9d5ef14eadaa000000ee0ec1fe7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58570); backlink

Unknown interpreted text role "ref".
      
heat-stack-id No string     Heat stack id corresponding to this instance, managed by MSO
interface-id Yes string     Unique ID of the interface
interface-role No string     Role assigned to this Interface, should use values as defined in ECOMP Yang models.
mso-catalog-key No string     Corresponds to the SDN-C catalog id used to configure this VCE
neutron-network-id No string     Neutron network id of this Interface
neutron-network-name No string     Neutron network name of this Interface
orchestration-status Yes string     Orchestration status of this VNF, mastered by MSO
port-group-id No string     Unique ID for port group in vmware
port-group-name No string     Likely to duplicate value of neutron network name
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58570); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
switch-name No string     DVS or standard switch name (should be non-null for port groups associated with DVS)

System Message: WARNING/2 (aai_swagger_v11.rst, line 58584); backlink

Duplicate explicit target name: "i_a144c9d5ef14eadaa000000ee0ec1fe7".

Cvlan-tag-entry schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58591); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

port-groups Model Structure

Name Required Type Format Properties Description
port-group No

array of :ref:`port-groups <i_c3124767cb91aa4d9d4c7ee0534ea230>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58608); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58610); backlink

Duplicate explicit target name: "i_c3124767cb91aa4d9d4c7ee0534ea230".

Port-groups schema:

project Model Structure

describes the project ###### Related Nodes - TO service-instance (One2Many)

Name Required Type Format Properties Description
project-name Yes string     Name of the project deploying a service
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58632); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 58636); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

projects Model Structure

Collection of projects

Name Required Type Format Properties Description
project No

array of :ref:`project <i_eccf78fe69afe99ba1b502bbdeacced3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58656); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58658); backlink

Duplicate explicit target name: "i_eccf78fe69afe99ba1b502bbdeacced3".

Project schema:

properties Model Structure

Property holder for query properties or instance properties

Name Required Type Format Properties Description
property-name No string      
property-value No string      

property-constraint Model Structure

TBD ###### Related Nodes - FROM named-query-element (is composed of property-constraint)

Name Required Type Format Properties Description
constraint-type Yes string      
property-constraint-uuid Yes string      
property-name Yes string      
property-value Yes string      
resource-version No string      

property-constraints Model Structure

Name Required Type Format Properties Description
property-constraint No

array of :ref:`property-constraint <i_0ae597bc5f078bbe4b4bf13aa13dd7c5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58712); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58714); backlink

Duplicate explicit target name: "i_0ae597bc5f078bbe4b4bf13aa13dd7c5".

Property-constraint schema:

pserver Model Structure

Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver. ###### Related Nodes - TO complex (Many2One) - TO cloud-region (Many2One) - TO availability-zone (Many2One) - TO lag-interface (comprises pserver, Many2Many) - TO p-interface (comprises pserver, Many2Many) - TO zone (Many2One) - FROM generic-vnf - FROM group-assignment - FROM vserver - FROM logical-link

Name Required Type Format Properties Description
disk-in-gigabytes No integer int32   Disk size, in GBs
equip-model No string     Equipment model. Source of truth should define valid values.
equip-type No string     Equipment type. Source of truth should define valid values.
equip-vendor No string     Equipment vendor. Source of truth should define valid values.
fqdn No string     Fully-qualified domain name
host-profile No string     The host profile that defines the configuration of the pserver.
hostname Yes string     Value from executing hostname on the compute node.
in-maint Yes boolean      
internet-topology No string     internet topology of Pserver
inv-status No string     CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
ipaddress-v4-aim No string     IPV4 AIM address
ipaddress-v4-loopback-0 No string     IPV4 Loopback 0 address
ipaddress-v6-aim No string     IPV6 AIM address
ipaddress-v6-loopback-0 No string     IPV6 Loopback 0 address
ipaddress-v6-oam No string     IPV6 OAM address
ipv4-oam-address No string     Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
lag-interfaces No

array of :ref:`lag-interfaces <i_4e64a03bc03e2b8a1c0aceda1cd15cbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58745); backlink

Unknown interpreted text role "ref".
      
management-option No string     Indicates who owns and or manages the device.
number-of-cpus No integer int32   Number of cpus
p-interfaces No

array of :ref:`p-interfaces <i_fff47b229d67b773a7fd59e4ded9c57e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58745); backlink

Unknown interpreted text role "ref".
      
prov-status No string     Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
pserver-id No string     ID of Pserver
pserver-name2 No string     alternative pserver name
pserver-selflink No string     URL to endpoint where AAI can get more details
ptnii-equip-name No string     PTNII name
purpose No string     purpose of pserver
ram-in-megabytes No integer int32   RAM size, in MBs
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58745); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
serial-number No string     Serial number, may be queried

System Message: WARNING/2 (aai_swagger_v11.rst, line 58776); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Lag-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58783); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

P-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 58790); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

pservers Model Structure

Collection of compute hosts.

Name Required Type Format Properties Description
pserver No

array of :ref:`pserver <i_52218c7dbc286864a4a5e4cdc72d4f10>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58810); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58812); backlink

Duplicate explicit target name: "i_52218c7dbc286864a4a5e4cdc72d4f10".

Pserver schema:

query-parameters Model Structure

QueryParameters for performing a named-query or model query

Name Required Type Format Properties Description
named-query No

:ref:`named-query <i_4e0f4025f8fa59c360954a4dbe0010ab>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58832); backlink

Unknown interpreted text role "ref".
      
overloaded-model No

:ref:`overloaded-model <i_1b8dff87af3b69d373882cfd7f1f7a0c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58832); backlink

Unknown interpreted text role "ref".
      

Named-query schema:

Overloaded-model schema:

relationship Model Structure

Name Required Type Format Properties Description
related-link No string     URL to the object in A&AI.
related-to No string     A keyword provided by A&AI to indicate type of node.
related-to-property No

array of :ref:`related-to-property <i_a7f42294c1df240b18be687410aade52>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58922); backlink

Unknown interpreted text role "ref".
      
relationship-data No

array of :ref:`relationship-data <i_19bb7d375e27e9a5b2a00a2b01dea30e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58922); backlink

Unknown interpreted text role "ref".
      

Related-to-property schema:

Relationship-data schema:

relationship-data Model Structure

Name Required Type Format Properties Description
relationship-key Yes string     A keyword provided by A&AI to indicate an attribute.
relationship-value Yes string     Value of the attribute.

relationship-list Model Structure

Name Required Type Format Properties Description
relationship No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 58964); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 58966); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

reserved-prop-names Model Structure

Internal map to define some reserved properties of a vertex

Name Required Type Format Properties Description
aai-created-ts No integer int64    
aai-last-mod-ts No integer int64    
aai-node-type No string      
aai-unique-key No string      
aai-uri No string      
last-mod-source-of-truth No string      
source-of-truth No string      

response-list Model Structure

Response container for the results of a named-query or model query

Name Required Type Format Properties Description
inventory-response-items No

:ref:`inventory-response-items <i_4fb91835eef824be5135a1a48e29395d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59007); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59009); backlink

Duplicate explicit target name: "i_4fb91835eef824be5135a1a48e29395d".

Inventory-response-items schema:

result-data Model Structure

Name Required Type Format Properties Description
resource-link No string     The URL to the specific resource
resource-type No string     The specific type of node in the A&AI graph

route-table-reference Model Structure

Openstack route table reference. ###### Related Nodes - FROM l3-network

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59044); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Concurrency value
route-table-reference-fqdn Yes string     FQDN entry in the route table.
route-table-reference-id Yes string     Route Table Reference id, UUID assigned to this instance.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59049); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

route-table-references Model Structure

Collection of openstack route table references

Name Required Type Format Properties Description
route-table-reference No

array of :ref:`route-table-references <i_6c59bd944f0e253bb650f63c9e4dd834>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59069); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59071); backlink

Duplicate explicit target name: "i_6c59bd944f0e253bb650f63c9e4dd834".

Route-table-references schema:

route-target Model Structure

Route target information ###### Related Nodes - FROM vpn-binding (is composed of route-target)

Name Required Type Format Properties Description
global-route-target Yes string     Number used to identify an RT, globally unique in the network
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59093); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
route-target-role Yes string     Role assigned to this route target

System Message: WARNING/2 (aai_swagger_v11.rst, line 59098); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

route-targets Model Structure

Collection of route target information

Name Required Type Format Properties Description
route-target No

array of :ref:`route-target <i_e84ce49cb4046bddbb69dcc1a6208b03>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59118); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59120); backlink

Duplicate explicit target name: "i_e84ce49cb4046bddbb69dcc1a6208b03".

Route-target schema:

routing-instance Model Structure

###### Related Nodes - TO site-pair (comprises routing-instance, Many2Many) - FROM site-pair-set (is composed of routing-instance)

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59142); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
routing-instance-id Yes string     Unique id of routing instance
rpm-owner No string     rpm owner
site-pairs No

array of :ref:`site-pairs <i_7e476101ecd6c387c928da450a1ab519>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59142); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59148); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59155); backlink

Duplicate explicit target name: "i_7e476101ecd6c387c928da450a1ab519".

Site-pairs schema:

routing-instances Model Structure

set of probes related to generic-vnf routing instance

Name Required Type Format Properties Description
routing-instance No

array of :ref:`routing-instances <i_c463eae2ffa9f71f1d8a65995b4c99da>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59175); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59177); backlink

Duplicate explicit target name: "i_c463eae2ffa9f71f1d8a65995b4c99da".

Routing-instances schema:

sdn-zone-response Model Structure

Name Required Type Format Properties Description
az-and-dvs-switches No

array of :ref:`az-and-dvs-switches <i_077c3e5a2ac5d0f998d182f9fc5acff7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59194); backlink

Unknown interpreted text role "ref".
      
oam-networks No

:ref:`oam-networks <i_2ad9ba625ee6330ac79627f84d715397>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59194); backlink

Unknown interpreted text role "ref".
      

Az-and-dvs-switches schema:

Oam-networks schema:

search Model Structure

Name Required Type Format Properties Description
edge-tag-query-request No

:ref:`edge-tag-query-request <i_249ff9d1e087828c77cc05478ac60aae>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59221); backlink

Unknown interpreted text role "ref".
      
edge-tag-query-result No

:ref:`edge-tag-query-result <i_82897430ba66ebf7f10935f565416188>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59221); backlink

Unknown interpreted text role "ref".
      
sdn-zone-response No

:ref:`sdn-zone-response <i_706b2830d0365d0caa53492d6cc3b692>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59221); backlink

Unknown interpreted text role "ref".
      
search-results No

:ref:`search-results <i_e198e9deabb25bc747e91ddebdcfdc52>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59221); backlink

Unknown interpreted text role "ref".
      

Edge-tag-query-request schema:

Edge-tag-query-result schema:

Sdn-zone-response schema:

Search-results schema:

search-results Model Structure

Name Required Type Format Properties Description
result-data No

array of :ref:`result-data <i_7d2afff34fa211cd45c798b9161163f5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59264); backlink

Unknown interpreted text role "ref".
      

Result-data schema:

secondary-filt Model Structure

SecondaryFilt for performing a named-query or model query

secondary-filter Model Structure

Name Required Type Format Properties Description
filter-type No string      
property-name No string      
property-value No string      

secondary-filts Model Structure

SecondaryFilts for performing a named-query or model query

Name Required Type Format Properties Description
secondary-filt No

array of :ref:`secondary-filt <i_e288c13c2ce7ef485506359e282f8cd6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59310); backlink

Unknown interpreted text role "ref".
      

Secondary-filt schema:

segmentation-assignment Model Structure

Openstack segmentation assignment. ###### Related Nodes - FROM l3-network (is composed of segmentation-assignment)

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59334); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Concurrency value
segmentation-id Yes string     Route Table Reference id, UUID assigned to this instance.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59338); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

segmentation-assignments Model Structure

Collection of openstack segmentation assignments

Name Required Type Format Properties Description
segmentation-assignment No

array of :ref:`segmentation-assignment <i_e3d1acc678a798310c1372b634684d81>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59358); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59360); backlink

Duplicate explicit target name: "i_e3d1acc678a798310c1372b634684d81".

Segmentation-assignment schema:

service Model Structure

Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59380); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service-description Yes string     Description of the service
service-id Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
service-selflink No string     URL to endpoint where AAI can get more details
service-version No string     service version

System Message: WARNING/2 (aai_swagger_v11.rst, line 59387); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

service-capabilities Model Structure

Collection of service capabilities.

Name Required Type Format Properties Description
service-capability No

array of :ref:`service-capabilities <i_df020d185ca9ad35b22723ace6bb6aa5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59407); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59409); backlink

Duplicate explicit target name: "i_df020d185ca9ad35b22723ace6bb6aa5".

Service-capabilities schema:

service-capability Model Structure

Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this. ###### Related Nodes - FROM availability-zone - FROM oam-network

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59432); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service-type Yes string     This gets defined by others to provide a unique ID for the service, we accept what is sent.
vnf-type Yes 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.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59437); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

service-design-and-creation Model Structure

Namespace for objects managed by ASDC

Name Required Type Format Properties Description
models No

array of :ref:`models <i_41777cd8804da9ec90bd3c37d52921e6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59457); backlink

Unknown interpreted text role "ref".
      
named-queries No

array of :ref:`named-query <i_fc6cb4831a97be8ac00f8f7dc7cc479e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59457); backlink

Unknown interpreted text role "ref".
      
service-capabilities No

array of :ref:`service-capabilities <i_df020d185ca9ad35b22723ace6bb6aa5>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59457); backlink

Unknown interpreted text role "ref".
      
services No

array of :ref:`services <i_87ea7700cb017e8a1daea49f67896277>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59457); backlink

Unknown interpreted text role "ref".
      
vnf-images No

array of :ref:`vnf-images <i_b72cbb3c300ae4fc4ee8fb19b5a89d04>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59457); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59463); backlink

Duplicate explicit target name: "i_41777cd8804da9ec90bd3c37d52921e6".

Models schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59470); backlink

Duplicate explicit target name: "i_fc6cb4831a97be8ac00f8f7dc7cc479e".

Named-query schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59477); backlink

Duplicate explicit target name: "i_df020d185ca9ad35b22723ace6bb6aa5".

Service-capabilities schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59484); backlink

Duplicate explicit target name: "i_87ea7700cb017e8a1daea49f67896277".

Services schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59491); backlink

Duplicate explicit target name: "i_b72cbb3c300ae4fc4ee8fb19b5a89d04".

Vnf-images schema:

service-instance Model Structure

Instance of a service ###### Related Nodes - TO configuration (One2Many) - TO zone (Many2One) - TO cvlan-tag (Many2Many) - TO pnf (One2Many) - TO connector (Many2Many) - TO metadatum (comprises service-instance, Many2Many) - TO logical-link (Many2Many) - TO vlan (One2Many) - TO service-instance (One2Many) - TO ctag-assignment (One2Many) - TO instance-group (Many2Many) - TO allotted-resource (comprises service-instance, Many2Many) - TO allotted-resource (Many2Many) - FROM generic-vnf - FROM l3-network - FROM owning-entity - FROM project - FROM service-subscription (is composed of service-instance) - FROM vce - FROM service-instance

Name Required Type Format Properties Description
allotted-resources No

array of :ref:`allotted-resources <i_525457a1212e4a768697d3941f0768b7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59532); backlink

Unknown interpreted text role "ref".
      
bandwidth-down-wan1 No string     indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
bandwidth-down-wan2 No string     indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
bandwidth-total No string     Indicates the total bandwidth to be used for this service.
bandwidth-up-wan1 No string     indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
bandwidth-up-wan2 No string     indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
environment-context No string     This field will store the environment context assigned to the service-instance.
metadata No

array of :ref:`metadata <i_6fb4789e41f9c692fc0616c746add31a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59532); backlink

Unknown interpreted text role "ref".
      
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
orchestration-status No string     Orchestration status of this service.
persona-model-version No string     the ASDC model version for this resource or service model.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59532); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
selflink No string     Path to the controller object.
service-instance-id Yes string     Uniquely identifies this instance of a service
service-instance-location-id No string     An identifier that customers assign to the location where this service is being used.
service-instance-name No string     This field will store a name assigned to the service-instance.
service-role Yes string     String capturing the service role.
service-type Yes string     String capturing type of service.
vhn-portal-url No string     URL customers will use to access the vHN Portal.
widget-model-id No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
workload-context No string     This field will store the workload context assigned to the service-instance.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59557); backlink

Duplicate explicit target name: "i_525457a1212e4a768697d3941f0768b7".

Allotted-resources schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59564); backlink

Duplicate explicit target name: "i_6fb4789e41f9c692fc0616c746add31a".

Metadata schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59571); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

service-instances Model Structure

Collection of service instances

Name Required Type Format Properties Description
service-instance No

array of :ref:`service-instance <i_56b73ff5fbd128ad31d4451e0c795541>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59591); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59593); backlink

Duplicate explicit target name: "i_56b73ff5fbd128ad31d4451e0c795541".

Service-instance schema:

service-subscription Model Structure

Object that group service instances. ###### Related Nodes - TO service-instance (comprises service-subscription, Many2Many) - FROM customer (is composed of service-subscription) - FROM tenant

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59617); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service-instances No

array of :ref:`service-instance <i_56b73ff5fbd128ad31d4451e0c795541>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59617); backlink

Unknown interpreted text role "ref".
      
service-type Yes string     Value defined by orchestration to identify this service across ECOMP.
temp-ub-sub-account-id No string     This property will be deleted from A&AI in the near future. Only stop gap solution.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59623); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59630); backlink

Duplicate explicit target name: "i_56b73ff5fbd128ad31d4451e0c795541".

Service-instance schema:

service-subscriptions Model Structure

Collection of objects that group service instances.

Name Required Type Format Properties Description
service-subscription No

array of :ref:`service-subscription <i_dd892e6b73902e5e959a9b8fc37a8ed3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59650); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59652); backlink

Duplicate explicit target name: "i_dd892e6b73902e5e959a9b8fc37a8ed3".

Service-subscription schema:

services Model Structure

Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.

Name Required Type Format Properties Description
service No

array of :ref:`services <i_87ea7700cb017e8a1daea49f67896277>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59672); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59674); backlink

Duplicate explicit target name: "i_87ea7700cb017e8a1daea49f67896277".

Services schema:

site-pair Model Structure

###### Related Nodes - TO class-of-service (comprises site-pair, Many2Many) - FROM routing-instance (is composed of site-pair)

Name Required Type Format Properties Description
classes-of-service No

array of :ref:`class-of-service <i_a331a9809d080190768162ebb857b2e4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59696); backlink

Unknown interpreted text role "ref".
      
destination-equip-type No string     The type of destinatination equipment. Could be Router, UCPE, etc.
destination-hostname No string     Hostname of the destination equipment to which SLAs are measured against.
destination-ip No string     Prefix address
ip-version No string     ip version, v4, v6
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59696); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
site-pair-id Yes string     unique identifier of probe
source-ip No string     Prefix address

System Message: WARNING/2 (aai_swagger_v11.rst, line 59706); backlink

Duplicate explicit target name: "i_a331a9809d080190768162ebb857b2e4".

Class-of-service schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59713); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

site-pair-set Model Structure

Set of instances for probes used to measure service level agreements ###### Related Nodes - TO routing-instance (comprises site-pair-set, Many2Many) - FROM generic-vnf

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59736); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
routing-instances No

array of :ref:`routing-instances <i_c463eae2ffa9f71f1d8a65995b4c99da>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59736); backlink

Unknown interpreted text role "ref".
      
site-pair-set-id Yes string     Unique id of site pair set.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59741); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 59748); backlink

Duplicate explicit target name: "i_c463eae2ffa9f71f1d8a65995b4c99da".

Routing-instances schema:

site-pair-sets Model Structure

Collection of sets of instances for probes related to generic-vnf

Name Required Type Format Properties Description
site-pair-set No

array of :ref:`site-pair-sets <i_675943dd0433645a183553fd21389c81>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59768); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59770); backlink

Duplicate explicit target name: "i_675943dd0433645a183553fd21389c81".

Site-pair-sets schema:

site-pairs Model Structure

probe within a set

Name Required Type Format Properties Description
site-pair No

array of :ref:`site-pairs <i_7e476101ecd6c387c928da450a1ab519>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59790); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59792); backlink

Duplicate explicit target name: "i_7e476101ecd6c387c928da450a1ab519".

Site-pairs schema:

snapshot Model Structure

Openstack snapshot ###### Related Nodes - FROM cloud-region (is composed of snapshot) - FROM vserver

Name Required Type Format Properties Description
application No string     The application that the image instantiates.
application-vendor No string     The vendor of the application.
application-version No string     The version of the application.
prev-snapshot-id No string     This field contains the UUID of the previous snapshot (if any).
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59815); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
snapshot-architecture No string     Operating system architecture
snapshot-id Yes string     Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
snapshot-name No string     Snapshot name
snapshot-os-distro No string     The common name of the operating system distribution in lowercase
snapshot-os-version No string     The operating system version as specified by the distributor.
snapshot-selflink No string     URL to endpoint where AAI can get more details

System Message: WARNING/2 (aai_swagger_v11.rst, line 59828); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

snapshots Model Structure

Collection of openstack snapshots

Name Required Type Format Properties Description
snapshot No

array of :ref:`snapshot <i_f766386b482511567bb8cf26fce6a7e7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59848); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59850); backlink

Duplicate explicit target name: "i_f766386b482511567bb8cf26fce6a7e7".

Snapshot schema:

sriov-pf Model Structure

SR-IOV Physical Function ###### Related Nodes - FROM p-interface (is composed of sriov-pf) - FROM sriov-vf

Name Required Type Format Properties Description
pf-pci-id Yes string     Identifier for the sriov-pf
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59873); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59877); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

sriov-pfs Model Structure

Collection of SR-IOV Physical Functions.

Name Required Type Format Properties Description
sriov-pf No

array of :ref:`sriov-pfs <i_b3470e561b5aa9542bf8ac5c2064c738>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59897); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59899); backlink

Duplicate explicit target name: "i_b3470e561b5aa9542bf8ac5c2064c738".

Sriov-pfs schema:

sriov-vf Model Structure

SR-IOV Virtual Function (not to be confused with virtual network function) ###### Related Nodes - TO sriov-pf (Many2One) - FROM l-interface (is composed of sriov-vf)

Name Required Type Format Properties Description
neutron-network-id No string     Neutron network id of the interface
pci-id Yes string     PCI ID used to identify the sriov-vf
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59922); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vf-broadcast-allow No boolean     This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
vf-insert-stag No boolean     This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
vf-link-status No string     This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
vf-mac-anti-spoof-check No boolean     This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
vf-mac-filter 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-mirrors No string     This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
vf-unknown-multicast-allow No boolean     This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
vf-unknown-unicast-allow No boolean     This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
vf-vlan-anti-spoof-check No boolean     This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
vf-vlan-filter No string     This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
vf-vlan-strip No boolean     When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.

System Message: WARNING/2 (aai_swagger_v11.rst, line 59938); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

sriov-vfs Model Structure

Collection of SR-IOV Virtual Functions.

Name Required Type Format Properties Description
sriov-vf No

array of :ref:`sriov-vf <i_282ce4c9acf1768d31303341d6d02da3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59958); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 59960); backlink

Duplicate explicit target name: "i_282ce4c9acf1768d31303341d6d02da3".

Sriov-vf schema:

start-node-filter Model Structure

Name Required Type Format Properties Description
property-name No string      
property-value No string      

subnet Model Structure

###### Related Nodes - TO host-route (comprises subnet, One2Many) - FROM l3-interface-ipv4-address-list - FROM l3-interface-ipv6-address-list - FROM l3-network (is composed of subnet) - FROM vip-ipv4-address-list - FROM vip-ipv6-address-list

Name Required Type Format Properties Description
cidr-mask No string     cidr mask
dhcp-enabled Yes boolean      
dhcp-end No string     the last address reserved for use by dhcp
dhcp-start No string     the start address reserved for use by dhcp
gateway-address No string     gateway ip address
host-routes No

array of :ref:`host-routes <i_34f35ddb128093303fb2b49a4e73aa29>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59999); backlink

Unknown interpreted text role "ref".
      
ip-assignment-direction No string     ip address assignment direction of the subnet
ip-version No string     ip version
network-start-address No string     network start address
neutron-subnet-id No string     Neutron id of this subnet
orchestration-status No string     Orchestration status of this VNF, mastered by MSO
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 59999); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
subnet-id Yes string     Subnet ID, should be UUID.
subnet-name No string     Name associated with the subnet.
subnet-role No string     role of the subnet, referenced when assigning IPs
subnet-sequence No integer int32   sequence of the subnet

System Message: WARNING/2 (aai_swagger_v11.rst, line 60017); backlink

Duplicate explicit target name: "i_34f35ddb128093303fb2b49a4e73aa29".

Host-routes schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60024); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

subnets Model Structure

Name Required Type Format Properties Description
subnet No

array of :ref:`subnets <i_66c5ac4d2c517349c9b71c59a5247423>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60041); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60043); backlink

Duplicate explicit target name: "i_66c5ac4d2c517349c9b71c59a5247423".

Subnets schema:

tagged-inventory-item-list Model Structure

Name Required Type Format Properties Description
inventory-item No

array of :ref:`inventory-item <i_47a8bf4f53c82adc5d05db861abd80ec>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60060); backlink

Unknown interpreted text role "ref".
      

Inventory-item schema:

tenant Model Structure

Openstack tenant ###### Related Nodes - TO l3-network (Many2Many) - TO service-subscription (Many2Many) - TO vserver (comprises tenant, One2Many) - FROM cloud-region (is composed of tenant) - FROM group-assignment - FROM volume-group

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60089); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
tenant-context No string     This field will store the tenant context.
tenant-id Yes string     Unique id relative to the cloud-region.
tenant-name Yes string     Readable name of tenant
vservers No

array of :ref:`vserver <i_dfa0cd5f7fd23be6afa43c24fc92fbf7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60089); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60096); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60103); backlink

Duplicate explicit target name: "i_dfa0cd5f7fd23be6afa43c24fc92fbf7".

Vserver schema:

tenants Model Structure

Collection of openstack tenants.

Name Required Type Format Properties Description
tenant No

array of :ref:`tenant <i_f330302f0065d2bdb215cc9170d4091e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60123); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60125); backlink

Duplicate explicit target name: "i_f330302f0065d2bdb215cc9170d4091e".

Tenant schema:

tunnel-xconnect Model Structure

Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted ###### Related Nodes - FROM allotted-resource (is composed of tunnel-xconnect)

Name Required Type Format Properties Description
bandwidth-down-wan1 Yes string     The WAN downlink bandwidth for WAN1
bandwidth-down-wan2 Yes string     The WAN downlink bandwidth for WAN2
bandwidth-up-wan1 Yes string     The WAN uplink bandwidth for WAN1
bandwidth-up-wan2 Yes string     The WAN uplink bandwidth for WAN2
id Yes string     Allotted Resource id UUID assigned to this instance.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60147); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Concurrency value

System Message: WARNING/2 (aai_swagger_v11.rst, line 60155); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

tunnel-xconnects Model Structure

This object is used to store the specific tunnel cross connect aspects of an allotted resource

Name Required Type Format Properties Description
tunnel-xconnect No

array of :ref:`tunnel-xconnects <i_2ebe2510685b62f9169f78f937be32d6>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60175); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60177); backlink

Duplicate explicit target name: "i_2ebe2510685b62f9169f78f937be32d6".

Tunnel-xconnects schema:

update Model Structure

Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.

Name Required Type Format Properties Description
action No

array of :ref:`action <i_2318bfa38687dc3e7bb749bef15ac7b0>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60197); backlink

Unknown interpreted text role "ref".
      
update-node-key No

array of :ref:`update-node-key <i_921027013fdfaec85bdcced00b84fa7d>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60197); backlink

Unknown interpreted text role "ref".
      
update-node-type Yes string      
update-node-uri No string      

Action schema:

Update-node-key schema:

update-node-key Model Structure

Name Required Type Format Properties Description
key-name No string      
key-value No string      

vce Model Structure

Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated. ###### Related Nodes - TO availability-zone (Many2Many) - TO complex (Many2Many) - TO port-group (comprises vce, Many2Many) - TO vserver (Many2Many) - TO service-instance (Many2Many) - TO entitlement (comprises vce, One2Many) - TO license (comprises vce, One2Many)

Name Required Type Format Properties Description
entitlement-resource-uuid No string     OBSOLETE - see child relationships
entitlements No

array of :ref:`entitlements <i_8a45c5f1e5a8567dd5e638a39f50fa80>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60250); backlink

Unknown interpreted text role "ref".
      
equipment-role No string     Network role being played by this VNF
heat-stack-id No string     Heat stack id corresponding to this instance, managed by MSO
ipv4-loopback0-address No string     Loopback0 address
ipv4-oam-address No string     Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
license-key No string     OBSOLETE - do not use
licenses No

array of :ref:`licenses <i_8c3e61f28428e06aef69620bca7330a3>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60250); backlink

Unknown interpreted text role "ref".
      
mso-catalog-key No string     Corresponds to the SDN-C catalog id used to configure this VCE
operational-status No string     Indicator for whether the resource is considered operational
orchestration-status No string     Orchestration status of this VNF, mastered by MSO
port-groups No

array of :ref:`port-groups <i_c3124767cb91aa4d9d4c7ee0534ea230>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60250); backlink

Unknown interpreted text role "ref".
      
prov-status No string     Trigger for operational monitoring of this resource by Service Assurance systems.
regional-resource-zone No string     Regional way of organizing pservers, source of truth should define values
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60250); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service-id No string     Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
v6-vce-wan-address No string     Valid v6 IP address for the WAN Link on this router. Implied length of /64.
vnf-id Yes string     Unique id of VNF. This is unique across the graph.
vnf-name Yes string     Name of VNF.
vnf-name2 No string     Alternate name of VNF.
vnf-type Yes 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.
vpe-id No string     Unique ID of VPE connected to this VCE.

System Message: WARNING/2 (aai_swagger_v11.rst, line 60274); backlink

Duplicate explicit target name: "i_8a45c5f1e5a8567dd5e638a39f50fa80".

Entitlements schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60281); backlink

Duplicate explicit target name: "i_8c3e61f28428e06aef69620bca7330a3".

Licenses schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60288); backlink

Duplicate explicit target name: "i_c3124767cb91aa4d9d4c7ee0534ea230".

Port-groups schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60295); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vces Model Structure

Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.

Name Required Type Format Properties Description
vce No

array of :ref:`vces <i_f28accb396e15e371eb59af79a5dbe5a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60315); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60317); backlink

Duplicate explicit target name: "i_f28accb396e15e371eb59af79a5dbe5a".

Vces schema:

vf-module Model Structure

a deployment unit of VNFCs ###### Related Nodes - TO volume-group (One2One) - TO l3-network (Many2Many) - TO vnfc (One2Many) - FROM vserver - FROM generic-vnf (is composed of vf-module)

Name Required Type Format Properties Description
contrail-service-instance-fqdn No string     the Contrail unique ID for a service-instance
heat-stack-id No string     Heat stack id corresponding to this instance.
is-base-vf-module Yes boolean      
model-customization-id No string     captures the id of all the configuration used to customize the resource for the service.
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
module-index No integer int32   the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
orchestration-status No string     orchestration status of this vf-module, mastered by MSO
persona-model-version No string     the ASDC model version for this resource or service model.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60343); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
selflink No string     Path to the controller object.
vf-module-id Yes string     Unique ID of vf-module.
vf-module-name No string     Name of vf-module
widget-model-id No string     the ASDC data dictionary widget model. This maps directly to the A&AI widget.
widget-model-version No string     the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.

System Message: WARNING/2 (aai_swagger_v11.rst, line 60360); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vf-modules Model Structure

Collection of vf-modules, a deployment unit of VNFCs

Name Required Type Format Properties Description
vf-module No

array of :ref:`vf-modules <i_1bbfa7555d39dc7b7b5e7e480eb6945a>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60380); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60382); backlink

Duplicate explicit target name: "i_1bbfa7555d39dc7b7b5e7e480eb6945a".

Vf-modules schema:

vig-server Model Structure

vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607 ###### Related Nodes - FROM ipsec-configuration (is composed of vig-server)

Name Required Type Format Properties Description
ipaddress-v4-vig No string     v4 IP of the vig server
ipaddress-v6-vig No string     v6 IP of the vig server
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60404); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vig-address-type Yes string     indicates whether the VIG is for AVPN or INTERNET

System Message: WARNING/2 (aai_swagger_v11.rst, line 60410); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vig-servers Model Structure

Name Required Type Format Properties Description
vig-server No

array of :ref:`vig-servers <i_59ca4cf5d26601abaafb921421316d97>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60427); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60429); backlink

Duplicate explicit target name: "i_59ca4cf5d26601abaafb921421316d97".

Vig-servers schema:

vip-ipv4-address-list Model Structure

IPv4 Address Range ###### Related Nodes - TO instance-group (Many2Many) - TO subnet (Many2Many) - FROM vnfc - FROM cloud-region (is composed of vip-ipv4-address-list)

Name Required Type Format Properties Description
is-floating No boolean     Indicator of fixed or floating address
neutron-network-id No string     Neutron network id of the interface that address belongs to
neutron-subnet-id No string     Neutron id of subnet that address belongs to
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60454); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vip-ipv4-address Yes string     IP address
vip-ipv4-prefix-length No integer int64   Prefix length, 32 for single address
vlan-id-inner No integer int64   Inner VLAN tag
vlan-id-outer No integer int64   Outer VLAN tag

System Message: WARNING/2 (aai_swagger_v11.rst, line 60464); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vip-ipv6-address-list Model Structure

IPv6 Address Range ###### Related Nodes - TO instance-group (Many2Many) - TO subnet (Many2Many) - FROM vnfc - FROM cloud-region (is composed of vip-ipv6-address-list)

Name Required Type Format Properties Description
is-floating No boolean     Indicator of fixed or floating address
neutron-network-id No string     Neutron network id of the interface that address belongs to
neutron-subnet-id No string     Neutron id of subnet that address belongs to
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60489); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vip-ipv6-address Yes string     IP address
vip-ipv6-prefix-length No integer int64   Prefix length, 128 for single address
vlan-id-inner No integer int64   Inner VLAN tag
vlan-id-outer No integer int64   Outer VLAN tag

System Message: WARNING/2 (aai_swagger_v11.rst, line 60499); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

virtual-data-center Model Structure

Virtual organization of cloud infrastructure elements in a data center context ###### Related Nodes - TO generic-vnf (Many2Many) - TO logical-link (Many2Many) - FROM connector

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60523); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vdc-id Yes string     Unique ID of the vdc
vdc-name Yes string     Name of the virtual data center

System Message: WARNING/2 (aai_swagger_v11.rst, line 60528); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

virtual-data-centers Model Structure

Virtual organization of cloud infrastructure elements in a data center context

Name Required Type Format Properties Description
virtual-data-center No

array of :ref:`virtual-data-center <i_1b23a1704dd539ff5fc1c13cc4d3b323>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60548); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60550); backlink

Duplicate explicit target name: "i_1b23a1704dd539ff5fc1c13cc4d3b323".

Virtual-data-center schema:

vlan Model Structure

Definition of vlan ###### Related Nodes - TO l3-interface-ipv4-address-list (comprises vlan, Many2Many) - TO l3-interface-ipv6-address-list (comprises vlan, Many2Many) - TO multicast-configuration (Many2Many) - TO logical-link (Many2Many) - FROM l-interface (is composed of vlan) - FROM service-instance - FROM allotted-resource

Name Required Type Format Properties Description
backdoor-connection No string     Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
in-maint Yes boolean      
is-ip-unnumbered Yes boolean      
l3-interface-ipv4-address-list No

array of :ref:`l3-interface-ipv4-address-list <i_bb0ca453b6a655cf421cc9c3f96bd80e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60578); backlink

Unknown interpreted text role "ref".
      
l3-interface-ipv6-address-list No

array of :ref:`l3-interface-ipv6-address-list <i_a6687b71c19d62d1985bf4722dc089f7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60578); backlink

Unknown interpreted text role "ref".
      
orchestration-status No string     Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
prov-status No string     Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60578); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
speed-units No string     Captures the units corresponding to the speed
speed-value No string     Captures the numeric part of the speed
vlan-description No string     Used to describe (the service associated with) the vlan
vlan-id-inner No integer int64   Inner VLAN tag
vlan-id-outer No integer int64   Outer VLAN tag
vlan-interface Yes string     String that identifies the interface
vpn-key No string     This indicates the customers VPN ID associated with this vlan

System Message: WARNING/2 (aai_swagger_v11.rst, line 60595); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

L3-interface-ipv4-address-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60602); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

L3-interface-ipv6-address-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60609); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vlans Model Structure

Name Required Type Format Properties Description
vlan No

array of :ref:`vlan <i_cf1c1ccb983fcd9fcd0b31440ada9380>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60626); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60628); backlink

Duplicate explicit target name: "i_cf1c1ccb983fcd9fcd0b31440ada9380".

Vlan schema:

vnf Model Structure

Abstract vnf class

Name Required Type Format Properties Description
vnf-id Yes string     Unique id of VNF. This is unique across the graph.

vnf-image Model Structure

Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge. ###### Related Nodes - FROM generic-vnf

Name Required Type Format Properties Description
application Yes string     The application that the image instantiates.
application-vendor Yes string     The vendor of the application.
application-version No string     The version of the application.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60665); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
selflink No string     URL to endpoint where AAI can get more details
vnf-image-uuid Yes string     Unique ID of this asset

System Message: WARNING/2 (aai_swagger_v11.rst, line 60673); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vnf-images Model Structure

Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.

Name Required Type Format Properties Description
vnf-image No

array of :ref:`vnf-images <i_b72cbb3c300ae4fc4ee8fb19b5a89d04>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60693); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60695); backlink

Duplicate explicit target name: "i_b72cbb3c300ae4fc4ee8fb19b5a89d04".

Vnf-images schema:

vnfc Model Structure

###### Related Nodes - TO instance-group (Many2Many) - TO vip-ipv4-address-list (Many2Many) - TO vip-ipv6-address-list (Many2Many) - FROM vserver - FROM vf-module - FROM generic-vnf - FROM l3-interface-ipv4-address-list (comprises vnfc) - FROM l3-interface-ipv6-address-list (comprises vnfc)

Name Required Type Format Properties Description
group-notation No string     Group notation of VNFC
in-maint Yes boolean      
ipaddress-v4-oam-vip No string     Oam V4 vip address of this vnfc
is-closed-loop-disabled Yes boolean      
l3-interface-ipv4-address-list No

array of :ref:`l3-interface-ipv4-address-list <i_bb0ca453b6a655cf421cc9c3f96bd80e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60723); backlink

Unknown interpreted text role "ref".
      
l3-interface-ipv6-address-list No

array of :ref:`l3-interface-ipv6-address-list <i_a6687b71c19d62d1985bf4722dc089f7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60723); backlink

Unknown interpreted text role "ref".
      
model-invariant-id No string     the ASDC model id for this resource or service model.
model-version-id No string     the ASDC model version for this resource or service model.
nfc-function Yes string     English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
nfc-naming-code Yes string     Short code that is used in naming instances of the item being modeled
orchestration-status No string     Orchestration status of this VNF, mastered by APP-C
prov-status No string     prov status of this vnfc
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60723); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vnfc-name Yes string     Unique ID of vnfc.

System Message: WARNING/2 (aai_swagger_v11.rst, line 60739); backlink

Duplicate explicit target name: "i_bb0ca453b6a655cf421cc9c3f96bd80e".

L3-interface-ipv4-address-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60746); backlink

Duplicate explicit target name: "i_a6687b71c19d62d1985bf4722dc089f7".

L3-interface-ipv6-address-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60753); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vnfcs Model Structure

virtual network components associated with a vserver from application controller.

Name Required Type Format Properties Description
vnfc No

array of :ref:`vnfc <i_120d1487fd3ba7687158894ca473218c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60773); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60775); backlink

Duplicate explicit target name: "i_120d1487fd3ba7687158894ca473218c".

Vnfc schema:

volume Model Structure

Ephemeral Block storage volume. ###### Related Nodes - FROM vserver (is composed of volume)

Name Required Type Format Properties Description
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60797); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
volume-id Yes string     Unique ID of block storage volume relative to the vserver.
volume-selflink Yes string     URL to endpoint where AAI can get more details

System Message: WARNING/2 (aai_swagger_v11.rst, line 60802); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

volume-group Model Structure

Persistent block-level storage. ###### Related Nodes - TO complex (Many2Many) - TO tenant (Many2Many) - FROM cloud-region (is composed of volume-group) - FROM vf-module - FROM generic-vnf

Name Required Type Format Properties Description
heat-stack-id No string     Heat stack id corresponding to this volume-group
model-customization-id No string     captures the id of all the configuration used to customize the resource for the service.
orchestration-status No string     Orchestration status of this volume-group
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60828); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vf-module-model-customization-id No string     helps relate the volume group to the vf-module whose components will require the volume group
vnf-type Yes 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.
volume-group-id Yes string     Unique ID of volume-group.
volume-group-name Yes string     Name of the volume group.

System Message: WARNING/2 (aai_swagger_v11.rst, line 60838); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

volume-groups Model Structure

Collection of persistent block-level storage.

Name Required Type Format Properties Description
volume-group No

array of :ref:`volume-group <i_9d66516837e3c652ee9f0a21a5bd748e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60858); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60860); backlink

Duplicate explicit target name: "i_9d66516837e3c652ee9f0a21a5bd748e".

Volume-group schema:

volumes Model Structure

Collection of ephemeral Block storage volumes.

Name Required Type Format Properties Description
volume No

array of :ref:`volumes <i_bc1fedb416ba33484ad0ebb947967501>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60880); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60882); backlink

Duplicate explicit target name: "i_bc1fedb416ba33484ad0ebb947967501".

Volumes schema:

vpls-pe Model Structure

VPLS Provider Edge routers. ###### Related Nodes - TO complex (Many2Many) - TO ctag-pool (Many2Many) - TO p-interface (comprises vpls-pe, Many2Many) - TO lag-interface (comprises vpls-pe, Many2Many)

Name Required Type Format Properties Description
equipment-name Yes string      
equipment-role No string     Client should send valid enumerated value, e.g., VPLS-PE.
ipv4-oam-address No string     Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
lag-interfaces No

array of :ref:`lag-interfaces <i_4e64a03bc03e2b8a1c0aceda1cd15cbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60907); backlink

Unknown interpreted text role "ref".
      
p-interfaces No

array of :ref:`p-interfaces <i_fff47b229d67b773a7fd59e4ded9c57e>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60907); backlink

Unknown interpreted text role "ref".
      
prov-status No string     Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60907); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vlan-id-outer No integer int64   Temporary location for stag to get to VCE

System Message: WARNING/2 (aai_swagger_v11.rst, line 60917); backlink

Duplicate explicit target name: "i_4e64a03bc03e2b8a1c0aceda1cd15cbc".

Lag-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60924); backlink

Duplicate explicit target name: "i_fff47b229d67b773a7fd59e4ded9c57e".

P-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60931); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

vpls-pes Model Structure

Collection of VPLS Provider Edge routers

Name Required Type Format Properties Description
vpls-pe No

array of :ref:`vpls-pes <i_b7200ee27877b16bc58e6ed01696c38c>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60951); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 60953); backlink

Duplicate explicit target name: "i_b7200ee27877b16bc58e6ed01696c38c".

Vpls-pes schema:

vpn-binding Model Structure

VPN binding ###### Related Nodes - TO route-target (comprises vpn-binding, One2Many) - FROM l3-network - FROM logical-link - FROM allotted-resource

Name Required Type Format Properties Description
customer-vpn-id No string     id for this customer vpn
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60978); backlink

Unknown interpreted text role "ref".
     l3-networks relate to vpn-bindings
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
route-distinguisher No string     Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
route-targets No

array of :ref:`route-target <i_e84ce49cb4046bddbb69dcc1a6208b03>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 60978); backlink

Unknown interpreted text role "ref".
      
vpn-id Yes string     VPN ID, globally unique within A&AI
vpn-name Yes string     VPN Name
vpn-platform No string     the platform associated with the VPN example AVPN, Mobility
vpn-region No string     region of customer vpn
vpn-type No string     Type of the vpn, should be taken from enumerated/valid values

System Message: WARNING/2 (aai_swagger_v11.rst, line 60989); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 60996); backlink

Duplicate explicit target name: "i_e84ce49cb4046bddbb69dcc1a6208b03".

Route-target schema:

vpn-bindings Model Structure

Name Required Type Format Properties Description
vpn-binding No

array of :ref:`vpn-binding <i_9748245f68da65b38b1103b9df0fd5b4>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61013); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 61015); backlink

Duplicate explicit target name: "i_9748245f68da65b38b1103b9df0fd5b4".

Vpn-binding schema:

vserver Model Structure

Virtual Servers, aka virtual machine or VM. ###### Related Nodes - TO flavor (Many2One) - TO image (Many2One) - TO l-interface (comprises vserver, Many2Many) - TO pserver (Many2One) - TO volume (comprises vserver, Many2Many) - TO vnfc (Many2Many) - TO snapshot (One2One) - TO vf-module (Many2One) - FROM generic-vnf - FROM tenant (is composed of vserver) - FROM vce

Name Required Type Format Properties Description
in-maint Yes boolean      
is-closed-loop-disabled Yes boolean      
l-interfaces No

array of :ref:`l-interfaces <i_70dce4555a00598a0ad7c7f8b41c9509>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61047); backlink

Unknown interpreted text role "ref".
      
prov-status No string     Trigger for operational monitoring of this resource by Service Assurance systems.
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61047); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Used for optimistic concurrency. Must be empty on create, valid on update and delete.
volumes No

array of :ref:`volumes <i_bc1fedb416ba33484ad0ebb947967501>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61047); backlink

Unknown interpreted text role "ref".
      
vserver-id Yes string     Unique identifier for this vserver relative to its tenant
vserver-name Yes string     Name of vserver
vserver-name2 No string     Alternative name of vserver
vserver-selflink Yes string     URL to endpoint where AAI can get more details

System Message: WARNING/2 (aai_swagger_v11.rst, line 61059); backlink

Duplicate explicit target name: "i_70dce4555a00598a0ad7c7f8b41c9509".

L-interfaces schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 61066); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

System Message: WARNING/2 (aai_swagger_v11.rst, line 61073); backlink

Duplicate explicit target name: "i_bc1fedb416ba33484ad0ebb947967501".

Volumes schema:

vservers Model Structure

Collection of virtual Servers, aka virtual machines or VMs.

Name Required Type Format Properties Description
vserver No

array of :ref:`vserver <i_dfa0cd5f7fd23be6afa43c24fc92fbf7>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61093); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 61095); backlink

Duplicate explicit target name: "i_dfa0cd5f7fd23be6afa43c24fc92fbf7".

Vserver schema:

zone Model Structure

A zone is a grouping of assets in a location homing to the same connections into the CBB ###### Related Nodes - TO complex (Many2One) - FROM cloud-region - FROM pserver - FROM pnf - FROM service-instance

Name Required Type Format Properties Description
design-type Yes string     Design of zone [Medium/Large?]
relationship-list No

array of :ref:`relationship-list <i_b285226bef3173cdfbbac84d245ff3e8>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61121); backlink

Unknown interpreted text role "ref".
      
resource-version No string     Concurrency value
status No string     Status of a zone.
zone-context Yes string     Context of zone [production/test]
zone-id Yes string     Code assigned by AIC to the zone
zone-name Yes string     English name associated with the zone

System Message: WARNING/2 (aai_swagger_v11.rst, line 61129); backlink

Duplicate explicit target name: "i_b285226bef3173cdfbbac84d245ff3e8".

Relationship-list schema:

zones Model Structure

Collection of zones

Name Required Type Format Properties Description
zone No

array of :ref:`zone <i_b071e942df8c17072bdd019656cdefbc>`

System Message: ERROR/3 (aai_swagger_v11.rst, line 61149); backlink

Unknown interpreted text role "ref".
      

System Message: WARNING/2 (aai_swagger_v11.rst, line 61151); backlink

Duplicate explicit target name: "i_b071e942df8c17072bdd019656cdefbc".

Zone schema: