Version: v10
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.
returns connectors
application/json application/xml
successful operation
Response codes found in response codes.
returns connector
resource-instance-id |
Unique id of resource instance. |
path | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing connector
application/json application/xml
connector object that needs to be created or updated
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing connector
application/json application/xml
resource-instance-id |
Unique id of resource instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
resource-instance-id |
Unique id of resource instance. |
path | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing metadatum
application/json application/xml
metadatum object that needs to be created or updated
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns customers
application/json application/xml
successful operation
Response codes found in response codes.
returns customer
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing customer
application/json application/xml
customer object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing customer
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string |
application/json application/xml
Response codes found in response codes.
returns service-subscriptions
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service-subscription
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing service-subscription
application/json application/xml
service-subscription object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-subscription
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string |
application/json application/xml
Response codes found in response codes.
returns service-instances
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service-instance
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string | |
service-instance-name |
This field will store a name assigned to the service-instance. |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
service-instance-location-id |
An identifier that customers assign to the location where this service is being used. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing service-instance
application/json application/xml
service-instance object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-instance
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string | |
service-instance-name |
This field will store a name assigned to the service-instance. |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
service-instance-location-id |
An identifier that customers assign to the location where this service is being used. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname | path | string | ||
subscriber-name |
Subscriber name, an alternate way to retrieve a customer. |
query | string | |
subscriber-type |
Subscriber type, a way to provide VID with only the INFRA customers. |
query | string | |
service-instance-name |
This field will store a name assigned to the service-instance. |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
service-instance-location-id |
An identifier that customers assign to the location where this service is being used. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing metadatum
application/json application/xml
metadatum object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
global-customer-id |
Global customer id used across ECOMP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ECOMP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string |
application/json application/xml
Response codes found in response codes.
returns cloud-regions
application/json application/xml
successful operation
Response codes found in response codes.
returns cloud-region
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing cloud-region
application/json application/xml
cloud-region object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing cloud-region
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns availability-zones
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns availability-zone
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing availability-zone
application/json application/xml
availability-zone object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing availability-zone
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
returns dvs-switches
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns dvs-switch
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
vcenter-url |
URL used to reach the vcenter |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing dvs-switch
application/json application/xml
dvs-switch object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing dvs-switch
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
returns flavors
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns flavor
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
flavor-name |
Flavor name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing flavor
application/json application/xml
flavor object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing flavor
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
returns group-assignments
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns group-assignment
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
group-type |
Group type - the type of group this instance refers to |
query | string | |
group-name |
Group name - name assigned to the group |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing group-assignment
application/json application/xml
group-assignment object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing group-assignment
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
returns images
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns image
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
image-name |
Image name |
query | string | |
application |
The application that the image instantiates. |
query | string | |
application-vendor |
The vendor of the application. |
query | string | |
application-version |
The version of the application. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing image
application/json application/xml
image object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing image
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
image-name |
Image name |
query | string | |
application |
The application that the image instantiates. |
query | string | |
application-vendor |
The vendor of the application. |
query | string | |
application-version |
The version of the application. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname | path | string | ||
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
image-name |
Image name |
query | string | |
application |
The application that the image instantiates. |
query | string | |
application-vendor |
The vendor of the application. |
query | string | |
application-version |
The version of the application. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing metadatum
application/json application/xml
metadatum object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
returns oam-networks
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns oam-network
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
network-name |
Name of the network. |
query | string | |
cvlan-tag |
cvlan-id |
query | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing oam-network
application/json application/xml
oam-network object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing oam-network
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
application/json application/xml
Response codes found in response codes.
returns snapshots
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns snapshot
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
snapshot-name |
Snapshot name |
query | string | |
application |
The application that the image instantiates. |
query | string | |
application-vendor |
The vendor of the application. |
query | string | |
application-version |
The version of the application. |
query | string | |
prev-snapshot-id |
This field contains the UUID of the previous snapshot (if any). |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing snapshot
application/json application/xml
snapshot object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing snapshot
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
application/json application/xml
Response codes found in response codes.
returns tenants
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns tenant
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing tenant
application/json application/xml
tenant object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing tenant
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vservers
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vserver
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vserver
application/json application/xml
vserver object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vserver
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
returns volumes
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean |
application/json application/xml
successful operation
Response codes found in response codes.
returns volume
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
tenant-name |
Readable name of tenant |
query | string | |
vserver-name |
Name of vserver |
query | string | |
vserver-name2 |
Alternative name of vserver |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing volume
application/json application/xml
volume object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing volume
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
application/json application/xml
Response codes found in response codes.
returns volume-groups
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns volume-group
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string | |
cloud-type |
Type of the cloud (e.g., openstack) |
query | string | |
owner-defined-type |
Cloud-owner defined type indicator (e.g., DCP, LCP) |
query | string | |
volume-group-name |
Name of the volume group. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this volume-group |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing volume-group
application/json application/xml
volume-group object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing volume-group
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
application/json application/xml
Response codes found in response codes.
returns complexes
application/json application/xml
successful operation
Response codes found in response codes.
returns complex
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
data-center-code |
Data center code which can be an alternate way to identify a complex |
query | string | |
complex-name |
Gamma complex name for LCP instance. |
query | string | |
identity-url |
URL of the keystone identity service |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing complex
application/json application/xml
complex object that needs to be created or updated
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing complex
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns ctag-pools
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
data-center-code |
Data center code which can be an alternate way to identify a complex |
query | string | |
complex-name |
Gamma complex name for LCP instance. |
query | string | |
identity-url |
URL of the keystone identity service |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns ctag-pool
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string | |
data-center-code |
Data center code which can be an alternate way to identify a complex |
query | string | |
complex-name |
Gamma complex name for LCP instance. |
query | string | |
identity-url |
URL of the keystone identity service |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ctag-pool
application/json application/xml
ctag-pool object that needs to be created or updated
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing ctag-pool
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-profiles
application/json application/xml
successful operation
Response codes found in response codes.
returns network-profile
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-profile
application/json application/xml
network-profile object that needs to be created or updated
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-profile
application/json application/xml
nm-profile-name |
Unique name of network profile. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
returns pservers
application/json application/xml
successful operation
Response codes found in response codes.
returns pserver
hostname |
Value from executing hostname on the compute node. |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pserver
application/json application/xml
pserver object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pserver
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
hostname |
Value from executing hostname on the compute node. |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-interface
application/json application/xml
lag-interface object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns p-interfaces
hostname |
Value from executing hostname on the compute node. |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns p-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing p-interface
application/json application/xml
p-interface object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing p-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
pserver-id |
ID of Pserver |
query | string | |
in-maint | query | boolean | ||
pserver-name2 |
alternative pserver name |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
hostname |
Value from executing hostname on the compute node. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string |
application/json application/xml
Response codes found in response codes.
returns virtual-data-centers
application/json application/xml
successful operation
Response codes found in response codes.
returns virtual-data-center
vdc-id |
Unique ID of the vdc |
path | string | |
vdc-name |
Name of the virtual data center |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing virtual-data-center
application/json application/xml
virtual-data-center object that needs to be created or updated
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing virtual-data-center
application/json application/xml
vdc-id |
Unique ID of the vdc |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
returns generic-vnfs
application/json application/xml
successful operation
Response codes found in response codes.
returns generic-vnf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing generic-vnf
application/json application/xml
generic-vnf object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing generic-vnf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-interface
application/json application/xml
lag-interface object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vf-modules
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vf-module
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
vf-module-name |
Name of vf-module |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance. |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
contrail-service-instance-fqdn |
the Contrail unique ID for a service-instance |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vf-module
application/json application/xml
vf-module object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vf-module
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
application/json application/xml
Response codes found in response codes.
returns ipsec-configurations
application/json application/xml
successful operation
Response codes found in response codes.
returns ipsec-configuration
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ipsec-configuration
application/json application/xml
ipsec-configuration object that needs to be created or updated
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing ipsec-configuration
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
returns vig-servers
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vig-server
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vig-server
application/json application/xml
vig-server object that needs to be created or updated
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vig-server
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-networks
application/json application/xml
successful operation
Response codes found in response codes.
returns l3-network
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-network
application/json application/xml
l3-network object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-network
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns ctag-assignments
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns ctag-assignment
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ctag-assignment
application/json application/xml
ctag-assignment object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing ctag-assignment
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
application/json application/xml
Response codes found in response codes.
returns segmentation-assignments
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns segmentation-assignment
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing segmentation-assignment
application/json application/xml
segmentation-assignment object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing segmentation-assignment
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns subnets
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns subnet
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
network-name |
Name of the network, governed by some naming convention.. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
contrail-network-fqdn |
Contrail FQDN for the network |
query | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
subnet-name |
Name associated with the subnet. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing subnet
application/json application/xml
subnet object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing subnet
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns lag-links
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-link
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-link
application/json application/xml
lag-link object that needs to be created or updated
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-link
application/json application/xml
link-name |
Alphabetical concatenation of lag-interface names |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
returns logical-links
application/json application/xml
successful operation
Response codes found in response codes.
returns logical-link
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string | |
persona-model-id |
the ASDC model id for this resource or service model. |
query | string | |
persona-model-version |
the ASDC model version for this resource or service model. |
query | string | |
widget-model-id |
the ASDC data dictionary widget model. This maps directly to the A&AI widget. |
query | string | |
widget-model-version |
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget. |
query | string | |
link-id |
UUID of the logical-link, SDNC generates this. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing logical-link
application/json application/xml
logical-link object that needs to be created or updated
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing logical-link
application/json application/xml
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
returns multicast-configurations
application/json application/xml
successful operation
Response codes found in response codes.
returns multicast-configuration
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing multicast-configuration
application/json application/xml
multicast-configuration object that needs to be created or updated
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing multicast-configuration
application/json application/xml
multicast-configuration-id |
Unique id of multicast configuration. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-policies
application/json application/xml
successful operation
Response codes found in response codes.
returns network-policy
network-policy-id |
UUID representing unique key to this instance |
path | string | |
network-policy-fqdn |
Contrail FQDN for the policy |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-policy
application/json application/xml
network-policy object that needs to be created or updated
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-policy
application/json application/xml
network-policy-id |
UUID representing unique key to this instance |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
returns newvces
application/json application/xml
successful operation
Response codes found in response codes.
returns newvce
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing newvce
application/json application/xml
newvce object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing newvce
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
returns physical-links
application/json application/xml
successful operation
Response codes found in response codes.
returns physical-link
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string | |
circuit-id |
Circuit it |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing physical-link
application/json application/xml
physical-link object that needs to be created or updated
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing physical-link
application/json application/xml
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
returns pnfs
application/json application/xml
successful operation
Response codes found in response codes.
returns pnf
pnf-name |
unique name of Physical Network Function. |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pnf
application/json application/xml
pnf object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pnf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
pnf-name |
unique name of Physical Network Function. |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-interface
application/json application/xml
lag-interface object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns p-interfaces
pnf-name |
unique name of Physical Network Function. |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns p-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing p-interface
application/json application/xml
p-interface object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing p-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
orchestration-status |
orchestration-status is the status of orchestration on the PNF. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
Response codes found in response codes.
returns route-table-references
application/json application/xml
successful operation
Response codes found in response codes.
returns route-table-reference
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string | |
route-table-reference-fqdn |
FQDN entry in the route table. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing route-table-reference
application/json application/xml
route-table-reference object that needs to be created or updated
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing route-table-reference
application/json application/xml
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns site-pair-sets
application/json application/xml
successful operation
Response codes found in response codes.
returns site-pair-set
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing site-pair-set
application/json application/xml
site-pair-set object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing site-pair-set
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
returns routing-instances
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns routing-instance
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing routing-instance
application/json application/xml
routing-instance object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing routing-instance
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
returns site-pairs
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns site-pair
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing site-pair
application/json application/xml
site-pair object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing site-pair
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns classes-of-service
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns class-of-service
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing class-of-service
application/json application/xml
class-of-service object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing class-of-service
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
returns vces
application/json application/xml
successful operation
Response codes found in response codes.
returns vce
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC. Expect this to change as ASDC matures. |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
vpe-id |
Unique ID of VPE connected to this VCE. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vce
application/json application/xml
vce object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vce
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns port-groups
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC. Expect this to change as ASDC matures. |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
vpe-id |
Unique ID of VPE connected to this VCE. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns port-group
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC. Expect this to change as ASDC matures. |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
vpe-id |
Unique ID of VPE connected to this VCE. |
query | string | |
port-group-id |
Unique ID for port group in vmware |
query | string | |
switch-name |
DVS or standard switch name (should be non-null for port groups associated with DVS) |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port-group
application/json application/xml
port-group object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port-group
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vnfcs
application/json application/xml
successful operation
Response codes found in response codes.
returns vnfc
vnfc-name |
Unique ID of vnfc. |
path | string | |
vnfc-function-code |
function code |
query | string | |
vnfc-type |
type |
query | string | |
prov-status |
prov status of this vnfc |
query | string | |
ipaddress-v4-oam-vip |
Oam V4 vip address of this vnfc |
query | string | |
in-maint | query | boolean | ||
is-closed-loop-disabled | query | boolean | ||
group-notation |
Group notation of VNFC |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vnfc
application/json application/xml
vnfc object that needs to be created or updated
vnfc-name |
Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vnfc
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnfc-name |
Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vpes
application/json application/xml
successful operation
Response codes found in response codes.
returns vpe
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vpe
application/json application/xml
vpe object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vpe
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-interface
application/json application/xml
lag-interface object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
vnf-name |
Name of VNF. |
query | string | |
vnf-name2 |
Alternate name of VNF. |
query | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
query | string | |
service-id |
Unique identifier of service from ASDC |
query | string | |
regional-resource-zone |
Regional way of organizing pservers, source of truth should define values |
query | string | |
prov-status |
Trigger for operational monitoring of this resource by Service Assurance systems. |
query | string | |
heat-stack-id |
Heat stack id corresponding to this instance, managed by MSO |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vpls-pes
application/json application/xml
successful operation
Response codes found in response codes.
returns vpls-pe
equipment-name | path | string | ||
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vpls-pe
application/json application/xml
vpls-pe object that needs to be created or updated
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vpls-pe
application/json application/xml
equipment-name | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
equipment-name | path | string | ||
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-interface
application/json application/xml
lag-interface object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns p-interfaces
equipment-name | path | string | ||
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns p-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing p-interface
application/json application/xml
p-interface object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing p-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vf-vlan-filter |
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM. |
query | string | |
vf-mac-filter |
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM. |
query | string | |
vf-vlan-strip |
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM. |
query | boolean | |
neutron-network-id |
Neutron network id of the interface |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
prov-status |
Trigger for operational monitoring of this VNF by BAU Service Assurance systems. |
query | string | |
interface-id |
ID of interface |
query | string | |
macaddr |
MAC address for the interface |
query | string | |
network-name |
Name of the network |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
vpn-id |
This indicates the customers VPN ID associated with this vlan |
query | string | |
vlan-id-inner |
Inner VLAN tag |
query | integer | |
neutron-network-id |
Neutron network id of the interface that address belongs to |
query | string | |
neutron-subnet-id |
Neutron id of subnet that address belongs to |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
returns vpn-bindings
application/json application/xml
successful operation
Response codes found in response codes.
returns vpn-binding
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
vpn-name |
VPN Name |
query | string | |
global-route-target |
Number used to identify a VPN, globally unique in the network |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vpn-binding
application/json application/xml
vpn-binding object that needs to be created or updated
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vpn-binding
application/json application/xml
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
returns models
application/json application/xml
successful operation
Response codes found in response codes.
returns model
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing model
application/json application/xml
model object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing metadatum
application/json application/xml
metadatum object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns model-elements
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns model-element
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing model-element
application/json application/xml
model-element object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model-element
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns model-constraints
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns model-constraint
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing model-constraint
application/json application/xml
model-constraint object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model-constraint
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns constrained-element-sets
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns constrained-element-set
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing constrained-element-set
application/json application/xml
constrained-element-set object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing constrained-element-set
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns element-choice-sets
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns element-choice-set
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string | ||
model-type |
Type of the model, e.g., service, resource, widget, etc. |
query | string | |
model-name |
Name of the model, which can change from version to version. |
query | string | |
model-id |
Invariant unique ID which does not change from version to version |
query | string | |
model-version |
Version |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing element-choice-set
application/json application/xml
element-choice-set object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing element-choice-set
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
model-name-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
returns named-queries
application/json application/xml
successful operation
Response codes found in response codes.
returns named-query
named-query-uuid | path | string | ||
named-query-name | query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing named-query
application/json application/xml
named-query object that needs to be created or updated
named-query-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing named-query
application/json application/xml
named-query-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns named-query-elements
named-query-uuid | path | string | ||
named-query-name | query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns named-query-element
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
named-query-name | query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing named-query-element
application/json application/xml
named-query-element object that needs to be created or updated
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing named-query-element
application/json application/xml
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns property-constraints
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
named-query-name | query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns property-constraint
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid | path | string | ||
named-query-name | query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing property-constraint
application/json application/xml
property-constraint object that needs to be created or updated
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing property-constraint
application/json application/xml
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
named-query-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
named-query-uuid | path | string |
application/json application/xml
Response codes found in response codes.
returns service-capabilities
application/json application/xml
successful operation
Response codes found in response codes.
returns service-capability
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing service-capability
application/json application/xml
service-capability object that needs to be created or updated
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-capability
application/json application/xml
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures. |
path | string |
application/json application/xml
Response codes found in response codes.
returns services
application/json application/xml
successful operation
Response codes found in response codes.
returns service
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
service-description |
Description of the service |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing service
application/json application/xml
service object that needs to be created or updated
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service
application/json application/xml
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vnf-images
application/json application/xml
successful operation
Response codes found in response codes.
returns vnf-image
vnf-image-uuid |
Unique ID of this asset |
path | string | |
application |
The application that the image instantiates. |
query | string | |
application-vendor |
The vendor of the application. |
query | string | |
application-version |
The version of the application. |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vnf-image
application/json application/xml
vnf-image object that needs to be created or updated
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vnf-image
application/json application/xml
vnf-image-uuid |
Unique ID of this asset |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
Availability zone, a collection of compute hosts/pservers
ERROR_IF_ANY_IN_EDGES
Name of the availability zone. Unique across a cloud region
Type of hypervisor. Source of truth should define valid values.
State that indicates whether the availability zone should be used, etc. Source of truth should define valid values.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of availability zones
unique identifier of probe
identifier of probe
type of probe
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
class-of-service of probe
Namespace for cloud infrastructure.
cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.
THIS_NODE_ONLY
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
Identifier used by the vendor for the region. Second part of composite key
Type of the cloud (e.g., openstack)
Cloud-owner defined type indicator (e.g., DCP, LCP)
Software version employed at the site
URL of the keystone identity service
Zone where the cloud is homed
complex name for cloud-region instance
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of physical locations that can house cloud-regions.
Unique identifier for physical location, e.g., CLLI
Data center code which can be an alternate way to identify a complex
Gamma complex name for LCP instance.
URL of the keystone identity service
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Type, e.g., central office, data center.
Collection of physical locations that can house cloud-regions.
Collection of resource instances used to connect a variety of disparate inventory widgets
Unique id of resource instance.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Collection of resource instances used to connect a variety of disparate inventory widgets
This is how we would capture constraints defining allowed sets of elements.
THIS_NODE_ONLY
id.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
A collection of C tags (vlan tags) grouped for a specific purpose.
The Target provider edge router
Name of the availability zone
Describes what the intended purpose of this pool is.
Comma separated list of ctags
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
customer identifiers to provide linkage back to BSS information.
CASCADE_TO_CHILDREN
Global customer id used across ECOMP to uniquely identify customer.
Subscriber name, an alternate way to retrieve a customer.
Subscriber type, a way to provide VID with only the INFRA customers.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of customer identifiers to provide linkage back to BSS information.
See mis-na-virtualization-platform.yang
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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.
DVS switch name
URL used to reach the vcenter
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of digital virtual switch metadata used for vmWare VCEs and VPEs.
Internal map to define the properties of an edge and interpret the map EdgeRules
This is how we would capture constraints defining allowed sets of elements.
Openstack flavor.
ERROR_IF_ANY_IN_EDGES
Flavor id, expected to be unique across cloud-region.
Flavor name
Number of CPUs
Amount of memory
Disk space
Amount of ephemeral disk space
amount of swap space allocation
whether flavor is available to all users or private to the tenant it was created in.
URL to endpoint where AAI can get more details
Boolean as to whether this flavor is no longer enabled
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of openstack flavors.
General purpose VNF
CASCADE_TO_CHILDREN
Unique id of VNF. This is unique across the graph.
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
Unique identifier of service from ASDC
Regional way of organizing pservers, source of truth should define values
Trigger for operational monitoring of this resource by Service Assurance systems.
Indicator for whether the resource is considered operational
License key
Client should send valid enumerated value
Orchestration status of this VNF, used by MSO.
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
identifier of managed by company or customer
Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by generic-vnf.
v4 Loopback0 address
v6 Loopback address
v6 management address
number of vcpus ordered for this instance of VNF, used for VNFs with no vservers/flavors
units associated with vcpu, used for VNFs with no vservers/flavors
number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors
units associated with vmemory, used for VNFs with no vservers/flavors
number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors
units associated with vdisk, used for VNFs with no vservers/flavors
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
details regarding the generic-vnf operation
indicates whether generic-vnf access uses SSH
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
as-number of the VNF
represents sub zone of the rr plane
Collection of VNFs
Openstack group-assignment used to store exclusivity groups (EG).
THIS_NODE_ONLY
Group id, expected to be unique across cloud-region.
Group type - the type of group this instance refers to
Group name - name assigned to the group
Group description - description of the group
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of openstack group assignments
Openstack image.
ERROR_4_IN_EDGES_OR_CASCADE
Image id, expected to be unique across cloud region
Image name
Operating system architecture.
The common name of the operating system distribution in lowercase
The operating system version as specified by the distributor.
The application that the image instantiates.
The vendor of the application.
The version of the application.
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collectio of Openstack images.
InstanceFilters for performing a named-query or model query
Inventory item for response list
Container for inventory items in response list
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
UUID of this configuration
Indicate the type of VIG server like AVPN, INTERNET, BOTH
Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
can offer a shared DMZ or a DMZ specific to a customer
Network address of shared DMZ
If the DMZ is a custom DMZ, this field will indicate the customer information
can be 1 or 2
Contains values like md5, sha1, sha256, sha384
Encyption values like 3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
Group name defined in VIG for clients using aggressive mode
pre-shared key for the above group name
Lifetime for IKEv1 SA
md5, sha1, sha256, sha384
3des-cbc, des-cbc, aes-128-cbc,?aes-192-cbc, aes-265-cbc
Life time for IPSec SA
enable PFS or not
user ID for xAuth, sm-user, ,nmteHostName
Encrypted using the Juniper $9$ algorithm
The time between DPD probe
Maximum number of DPD before claiming the tunnel is down
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Logical interfaces, e.g., a vnic.
CASCADE_TO_CHILDREN
Name given to the interface
E.g., CUSTOMER, UPLINK, etc.
Questionably placed - v6 ip addr of this interface (is in vr-lan-interface from Mary B.
URL to endpoint where AAI can get more details
ID of interface
MAC address for the interface
Name of the network
Whether A&AI should be managing this interface of not. Could have value like CUSTOMER
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of logical interfaces.
IPv4 Address Range
THIS_NODE_ONLY
IP address
Prefix length, 32 for single address
Inner VLAN tag
Outer VLAN tag
Indicator of fixed or floating address
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Neutron network id of the interface that address belongs to
Neutron id of subnet that address belongs to
IPv6 Address Range
THIS_NODE_ONLY
IP address
Prefix length, 128 for single address
Inner VLAN tag
Outer VLAN tag
Indicator of fixed or floating address
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Neutron network id of the interface that address belongs to
Neutron id of subnet that address belongs to
Generic network definition
CASCADE_TO_CHILDREN
Network ID, should be uuid. Unique across A&AI.
Name of the network, governed by some naming convention..
Type of the network - who defines these values?
Role the network plans - who defines these values?
Network technology - who defines these values?
Neutron network id of this Interface
Unique identifier of service from ASDC
network role instance
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Contrail FQDN for the network
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Name associated with the physical network.
Link aggregate interface
CASCADE_TO_CHILDREN
Name that identifies the link aggregate interface
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Captures the numeric part of the speed
Captures the units corresponding to the speed
Collection of link aggregate interfaces.
LAG links can connect lag-interfaces
Alphabetical concatenation of lag-interface names
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of link aggregation connections
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
THIS_NODE_ONLY
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
Type of logical link, e.g., evc
Captures the numeric part of the speed
Captures the units corresponding to the speed
v4, v6, or ds for dual stack
For example, static or BGP
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Indication of operational status of the logical link.
Indication of the network use of the logical link.
Alias or alternate name (CLCI or D1 name).
UUID of the logical-link, SDNC generates this.
Collection of logical connections
Collection of metadatum (key/value pairs)
THIS_NODE_ONLY
Key/value pairs
THIS_NODE_ONLY
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models
ERROR_4_IN_EDGES_OR_CASCADE
Unique identifier corresponding to one version of a model in ASDC
Type of the model, e.g., service, resource, widget, etc.
Name of the model, which can change from version to version.
Invariant unique ID which does not change from version to version
Version
Description
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
ModelAndNamedQuerySearch holds query-parameters and instance-properties for performing a named-query or model query
This is how we would capture constraints defining allowed sets of elements.
Defines how other models combine to make up a higher-level model.
CASCADE_TO_CHILDREN
Indicates whether this element was created as part of instantiation from this model
How many of this type of element are required/allowed
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
Unique id of multicast configuration.
protocol of multicast configuration
rp type of multicast configuration
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
multicast configuration of generic-vnf ip-address
TBD
CASCADE_TO_CHILDREN
TBD
CASCADE_TO_CHILDREN
Namespace for network inventory resources.
UUID representing unique key to this instance
Contrail FQDN for the policy
ID for the openStack Heat instance
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Network profile populated by SDN-GP for SNMP
Unique name of network profile.
Encrypted SNMP community string
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of network profiles
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
Unique id of VNF, can't use same attribute name right now until we promote this new object
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
Indicator for whether the resource is considered operational
License key
Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
Client should send valid enumerated value, e.g., VPE.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
v4 Loopback0 address
Orchestration status of this VNF, mastered by MSO.
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
OAM network, to be deprecated shortly. Do not use for new purposes.
UUID of the network. Unique across a cloud-region
Name of the network.
cvlan-id
Used for VNF firewall rule so customer cannot send customer traffic over this oam network
Used for VNF firewall rule so customer cannot send customer traffic over this oam network
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
Physical interface (e.g., nic)
CASCADE_TO_CHILDREN
Name that identifies the physical interface
Captures the numeric part of the speed
Captures the units corresponding to the speed
Nature of the services and connectivity on this port.
CLEI or other specification for p-interface hardware.
Role specification for p-interface hardware.
Indicates the physical properties of the interface.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of physical interfaces.
Collection of physical connections, typically between p-interfaces
THIS_NODE_ONLY
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ
Captures the numeric part of the speed
Captures the units corresponding to the speed
Circuit it
Dual access mode (e.g., primary, secondary
To provide information on who manages this circuit. A&AI or 3rd party transport provider
Name of the service Provider on this link.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of physical connections, typically between p-interfaces
PNF represents a physical network function. typically equipment used in the D1 world.
CASCADE_TO_CHILDREN
unique name of Physical Network Function.
name of Physical Network Function.
source of name2
id of pnf
Equipment type. Source of truth should define valid values.
Equipment vendor. Source of truth should define valid values.
Equipment model. Source of truth should define valid values.
identifier of managed by company or customer
ipv4-oam-address with new naming convention for IP addresses
sw-version is the version of SW for the hosted application on the PNF.
orchestration-status is the status of orchestration on the PNF.
ID of the physical frame (relay rack) where pnf is installed.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of Physical Network Functions.
Used to capture the network interfaces of this VCE
Unique ID of the interface
Neutron network id of this Interface
Neutron network name of this Interface
Role assigned to this Interface, should use values as defined in ECOMP Yang models.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Unique ID for port group in vmware
Likely to duplicate value of neutron network name
DVS or standard switch name (should be non-null for port groups associated with DVS)
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Property holder for query properties or instance properties
TBD
Compute host whose hostname must be unique and must exactly match what is sent as a relationship to a vserver.
ERROR_4_IN_EDGES_OR_CASCADE
Value from executing hostname on the compute node.
PTNII name
Number of cpus
Disk size, in GBs
RAM size, in MBs
Equipment type. Source of truth should define valid values.
Equipment vendor. Source of truth should define valid values.
Equipment model. Source of truth should define valid values.
Fully-qualified domain name
URL to endpoint where AAI can get more details
Used to configure device, also used for troubleshooting and is IP used for traps generated by device.
Serial number, may be queried
ID of Pserver
internet topology of Pserver
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
alternative pserver name
purpose of pserver
Collection of compute hosts.
QueryParameters for performing a named-query or model query
A keyword provided by A&AI to indicate type of node.
URL to the object in A&AI.
A keyword provided by A&AI to indicate an attribute.
Value of the attribute.
Internal map to define some reserved properties of a vertex
Response container for the results of a named-query or model query
The specific type of node in the A&AI graph
The URL to the specific resource
Openstack route table reference.
Route Table Reference id, UUID assigned to this instance.
FQDN entry in the route table.
Concurrency value
Collection of openstack route table references
Unique id of routing instance
rpm owner
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
set of probes related to generic-vnf routing instance
Openstack segmentation assignment.
THIS_NODE_ONLY
Route Table Reference id, UUID assigned to this instance.
Concurrency value
Collection of openstack segmentation assignments
Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC.
ERROR_IF_ANY_IN_EDGES
This gets defined by others to provide a unique ID for the service, we accept what is sent.
Description of the service
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service version
Collection of service capabilities.
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
This gets defined by others to provide a unique ID for the service, we accept what is sent.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Namespace for objects managed by ASDC
Instance of a service
CASCADE_TO_CHILDREN
Uniquely identifies this instance of a service
This field will store a name assigned to the service-instance.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Indicates the total bandwidth to be used for this service.
indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
URL customers will use to access the vHN Portal.
An identifier that customers assign to the location where this service is being used.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of service instances
Object that group service instances.
CASCADE_TO_CHILDREN
Value defined by orchestration to identify this service across ECOMP.
This property will be deleted from A&AI in the near future. Only stop gap solution.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of objects that group service instances.
Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
unique identifier of probe
Prefix address
Prefix address
ip version, v4, v6
Hostname of the destination equipment to which SLAs are measured against.
The type of destinatination equipment. Could be Router, etc.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Set of instances for probes used to measure service level agreements
Unique id of site pair set.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of sets of instances for probes related to generic-vnf
probe within a set
Openstack snapshot
THIS_NODE_ONLY
Snapshot id, this is the key UUID assoc associated in glance with the snapshots.
Snapshot name
Operating system architecture
The common name of the operating system distribution in lowercase
The operating system version as specified by the distributor.
The application that the image instantiates.
The vendor of the application.
The version of the application.
URL to endpoint where AAI can get more details
This field contains the UUID of the previous snapshot (if any).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of openstack snapshots
SR-IOV Virtual Function (not to be confused with virtual network function)
PCI ID used to identify the sriov-vf
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
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.
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.
This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Neutron network id of the interface
Collection of SR-IOV Virtual Functions.
THIS_NODE_ONLY
Subnet ID, should be UUID.
Name associated with the subnet.
Neutron id of this subnet
gateway ip address
network start address
cidr mask
ip version
Orchestration status of this VNF, mastered by MSO
the start address reserved for use by dhcp
the last address reserved for use by dhcp
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Openstack tenant
THIS_NODE_ONLY
Unique id relative to the cloud-region.
Readable name of tenant
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of openstack tenants.
Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
Unique id of VNF. This is unique across the graph.
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
Unique identifier of service from ASDC. Expect this to change as ASDC matures.
Regional way of organizing pservers, source of truth should define values
Trigger for operational monitoring of this resource by Service Assurance systems.
Indicator for whether the resource is considered operational
License key
Network role being played by this VNF
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Unique ID of VPE connected to this VCE.
Valid v6 IP address for the WAN Link on this router. Implied length of /64.
Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Loopback0 address
Entitlement resource uuid
Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
a deployment unit of VNFCs
THIS_NODE_ONLY
Unique ID of vf-module.
Name of vf-module
Heat stack id corresponding to this instance.
orchestration status of this vf-module, mastered by MSO
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
the Contrail unique ID for a service-instance
Collection of vf-modules, a deployment unit of VNFCs
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
indicates whether the VIG is for AVPN or INTERNET
v4 IP of the vig server
v6 IP of the vig server
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Virtual organization of cloud infrastructure elements in a data center context
Unique ID of the vdc
Name of the virtual data center
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Virtual organization of cloud infrastructure elements in a data center context
Definition of vlan
CASCADE_TO_CHILDREN
String that identifies the interface
Inner VLAN tag
Outer VLAN tag
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Captures the numeric part of the speed
Captures the units corresponding to the speed
Used to describe (the service associated with) the vlan
Whether customer is going to use this VLAN for backdoor connection to another customer premise device.
This indicates the customers VPN ID associated with this vlan
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
Unique ID of this asset
The application that the image instantiates.
The vendor of the application.
The version of the application.
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
THIS_NODE_ONLY
Unique ID of vnfc.
function code
type
prov status of this vnfc
Orchestration status of this VNF, mastered by APP-C
Oam V4 vip address of this vnfc
Group notation of VNFC
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
virtual network components associated with a vserver from application controller.
Ephemeral Block storage volume.
THIS_NODE_ONLY
Unique ID of block storage volume relative to the vserver.
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Persistent block-level storage.
THIS_NODE_ONLY
Unique ID of volume-group.
Name of the volume group.
Heat stack id corresponding to this volume-group
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
Orchestration status of this volume-group
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of persistent block-level storage.
Collection of ephemeral Block storage volumes.
Relationship-list must include related to info for complex.
Unique id of VNF. This is unique across the graph.
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded and clients should expect changes to occur in the future to this field as ASDC matures.
Unique identifier of service from ASDC
Regional way of organizing pservers, source of truth should define values
Trigger for operational monitoring of this resource by Service Assurance systems.
Indicator for whether the resource is considered operational
License key
Client should send valid enumerated value
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
Prefix length for oam-address
Gateway address
Loopback0 address
Temporary location for stag to get to VCE
as-number of the VPE
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
details regarding the vpe operation
indicates whether vpe access uses SSH
Virtual provider edge router. In 1504, A&AI will populate this object through an M&P and tool provided to operations.
VPLS Provider Edge routers.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
Address tail-f uses to configure vpe, also used for troubleshooting and is IP used for traps generated by VPE (v4-loopback0-ip-address).
Client should send valid enumerated value, e.g., VPLS-PE.
Temporary location for stag to get to VCE
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of VPLS Provider Edge routers
VPN binding
VPN ID, globally unique within A&AI
VPN Name
Number used to identify a VPN, globally unique in the network
the platform associated with the VPN example AVPN, Mobility
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Virtual Servers, aka virtual machine or VM.
CASCADE_TO_CHILDREN
Unique identifier for this vserver relative to its tenant
Name of vserver
Alternative name of vserver
Trigger for operational monitoring of this resource by Service Assurance systems.
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of virtual Servers, aka virtual machines or VMs.