Version: v8
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
AAI REST API
returns customers
application/json application/xml
successful operation
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.
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 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.
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.
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.
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.
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 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.
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.
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.
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 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.
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.
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.
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 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.
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.
returns cloud-regions
application/json application/xml
successful operation
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 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 |
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.
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 |
query | string |
application/json application/xml
successful operation
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.
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 |
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 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.
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.
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 |
query | string |
application/json application/xml
successful operation
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.
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 |
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 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.
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.
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 |
query | string |
application/json application/xml
successful operation
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.
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 |
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 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.
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.
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 |
query | string |
application/json application/xml
successful operation
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 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 |
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.
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 |
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.
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.
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 |
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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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 |
query | string |
application/json application/xml
successful operation
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.
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 |
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 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.
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.
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 |
query | string |
application/json application/xml
successful operation
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.
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 |
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 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.
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.
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 |
query | string | |
| tenant-name | Readable name of tenant |
query | string |
application/json application/xml
successful operation
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 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 |
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.
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 |
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.
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 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 |
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 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.
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 |
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 (int64) | |
| 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 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.
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 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.
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 |
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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 |
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.
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 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 |
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 (int64) | |
| 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 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.
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 |
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 |
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
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 |
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.
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.
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 |
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 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.
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.
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 |
query | string |
application/json application/xml
successful operation
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.
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 |
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 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.
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.
returns pservers
application/json application/xml
successful operation
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 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.
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.
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 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.
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.
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 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 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.
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 (int64) | |
| 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 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.
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 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.
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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 (int64) | |
| 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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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.
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.
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 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 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.
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 (int64) | |
| 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 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.
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 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.
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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 (int64) | |
| 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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
returns generic-vnfs
application/json application/xml
successful operation
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 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.
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.
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 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 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.
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 (int64) | |
| 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 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.
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 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.
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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 (int64) | |
| 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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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.
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.
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 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 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.
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 (int64) | |
| 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 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.
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 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.
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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 (int64) | |
| 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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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.
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 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.
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.
returns l3-networks
application/json application/xml
successful operation
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 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.
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.
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 (int64) | |
| resource-version | resource-version for concurrency |
query | string |
application/json application/xml
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 (int64) | |
| 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 (int64) |
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 (int64) |
application/json application/xml
Response codes found in response codes.
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 (int64) |
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.
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.
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.
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.
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 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.
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.
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.
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.
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 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.
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.
returns logical-links
application/json application/xml
successful operation
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.
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 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.
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.
returns physical-links
application/json application/xml
successful operation
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.
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 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.
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.
returns pnfs
application/json application/xml
successful operation
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 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.
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.
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 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.
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.
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 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 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.
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 (int64) | |
| 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 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.
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 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.
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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 (int64) | |
| 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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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.
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.
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 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 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.
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 (int64) | |
| 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 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.
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 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.
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 (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
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.
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 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 (int64) | |
| 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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 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.
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 (int64) | |
| vpn-id | This indicates the customers VPN ID associated with this vlan |
query | string | |
| vlan-id-inner | Inner VLAN tag |
query | integer (int64) | |
| 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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
returns vnfcs
application/json application/xml
successful operation
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.
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 relationship
application/json application/xml
| vnfc-name | Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
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.
returns models
application/json application/xml
successful operation
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 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.
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.
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 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.
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.
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-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.
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.
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 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.
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.
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 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.
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.
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.
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 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.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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 |
application/json application/xml
Response codes found in response codes.
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.
returns named-queries
application/json application/xml
successful operation
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
| 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.
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.
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 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.
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.
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.
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 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.
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 |
application/json application/xml
Response codes found in response codes.
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.
returns services
application/json application/xml
successful operation
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.
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 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.
create or update an existing relationship
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.
Availability zone, a collection of compute hosts/pservers
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
Namespace for business related constructs
Namespace for cloud infrastructure.
cloud-region designates an installation of a cloud cluster or region or instantiation. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname.
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
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.
This is how we would capture constraints defining allowed sets of elements.
id.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
customer identifiers to provide linkage back to BSS information.
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.
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.
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
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 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
UUID of the Entitlement group used for licensing VNFs
UUID of the specific entitlement resource
UUID of the license assignment group
UUID of the actual license resource
the ASDC model id 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).
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.
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
Logical interfaces, e.g., a vnic.
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
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
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
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 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.
Relates to tenant (or is it a child of tenant)
Link aggregate interface
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.
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
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 (should be ip-version)
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 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)
Key/value pairs
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
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.
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.
Defines how other models combine to make up a higher-level model
Describes new constraints on this model element that are not part of that model's definition
Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
TBD
TBD
Namespace for network inventory resources.
Physical interface (e.g., nic)
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
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.
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 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.
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.
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 segmentation assignment.
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.
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
Namespace for objects managed by ASDC
Instance of a service
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 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.
Operational status of the service-instance.
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.
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.
Openstack snapshot
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
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
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.
a deployment unit of VNFCs
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 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
Definition of vlan
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
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.
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.
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.
Virtual Servers, aka virtual machine or VM.
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.
AAI will use the following HTTP codes:
Successful PUT responses shall return the following codes:
200 (OK): used when an existing resource has been modified and there is a response buffer
202 (Accepted): used when AAI completed the action requested but may have taken other actions as well, which are returned in the response payload
204(No Content): used when the existing resource has been modified and there is no response buffer
201 (Created): MUST be used when a new resource is created (to be added in v5)
Successful DELETE responses shall return the following codes:
200 (OK): for a successful response if the response includes an entity describing the status.
204 (No Content): if the action has been enacted but the response does not include an entity.
Successful GET responses shall return the following codes:
200 (OK): for a successful response for a resource that has been found
200 (OK) plus an empty list: for a successful response retrieving a list of items and there were no items found.
404 (Not Found): when a specific resource was not found
Failures:
400 Bad Request will be returned if headers are missing
404 Not Found will be returned if an unknown URL is used
| Code | Message | Disposition | Category | Severity | HTTP Code | REST Code |
|---|---|---|---|---|---|---|
| 0000 | Error code for testing | 5 | 2 | WARN | 400 | 0001 |
| 0000 | Success | 0 | 0 | INFO | 200 | 0000 |
| 0001 | Success X-FromAppId=%1 X-TransactionId=%2 | 0 | 0 | INFO | 200 | 0001 |
| 0002 | Successful health check | 0 | 0 | INFO | 200 | 0001 |
| 0003 | Success with additional info performing %1 on %2. Added %3 with key %4 | 0 | 3 | INFO | 202 | 0003 |
| 0004 | Added prerequisite object to db | 0 | 3 | INFO | 202 | 0003 |
| 3000 | Invalid input performing %1 on %2 | 5 | 2 | INFO | 400 | 3000 |
| 3001 | Resource not found for %1 using id %2 | 5 | 6 | INFO | 404 | 3001 |
| 3002 | Error writing output performing %1 on %2 | 5 | 1 | WARN | 400 | 3002 |
| 3003 | Failed to make edge to missing target node of type %3 with keys %4 performing %1 on %2 | 5 | 1 | WARN | 400 | 3003 |
| 3005 | Node cannot be directly accessed for read, must be accessed via ancestor(s) | 5 | 6 | WARN | 404 | 3001 |
| 3006 | Node cannot be directly accessed for write, must be accessed via ancestor(s) | 5 | 6 | WARN | 404 | 3001 |
| 3007 | This version (%1) of the API is retired, please migrate to %2 | 5 | 6 | INFO | 410 | 3007 |
| 3008 | URI is not encoded in UTF-8 | 5 | 6 | ERROR | 400 | 3008 |
| 3009 | Malformed URL | 5 | 6 | ERROR | 400 | 3002 |
| 3100 | Unsupported operation %1 | 5 | 1 | WARN | 400 | 3100 |
| 3101 | Attempt by client %1 to execute API %2 | 5 | 1 | WARN | 403 | 3101 |
| 3102 | Error parsing input performing %1 on %2 | 5 | 1 | WARN | 400 | 3102 |
| 3300 | Unauthorized | 5 | 1 | WARN | 403 | 3300 |
| 3301 | Stale credentials | 5 | 1 | WARN | 401 | 3301 |
| 3302 | Not authenticated | 5 | 1 | WARN | 401 | 3301 |
| 4000 | Internal Error | 5 | 4 | ERROR | 500 | 3002 |
| 4001 | Configuration file not found | 5 | 4 | FATAL | 500 | 3002 |
| 4002 | Error reading Configuration file | 5 | 4 | FATAL | 500 | 3002 |
| 4003 | Error writing to log file | 5 | 4 | ERROR | 500 | 3002 |
| 4004 | Error reading/parsing the error properties file | 5 | 4 | FATAL | 500 | 3002 |
| 4005 | Missing or invalid configuration parameter | 5 | 4 | FATAL | 500 | 3002 |
| 4006 | Unexpected error in service | 5 | 4 | FATAL | 500 | 3002 |
| 4007 | Input parsing error | 5 | 4 | ERROR | 500 | 3102 |
| 4008 | Output parsing error | 5 | 4 | ERROR | 500 | 3002 |
| 4009 | Invalid X-FromAppId in header | 4 | 0 | ERROR | 400 | 3000 |
| 4010 | Invalid X-TransactionId in header | 4 | 0 | ERROR | 400 | 3000 |
| 4011 | Missing data for REST error response | 5 | 4 | ERROR | 500 | 3002 |
| 4012 | Bad rule data in RestRules | 5 | 4 | ERROR | 500 | 3002 |
| 4013 | Error connecting to AAI REST API | 5 | 4 | ERROR | 500 | 3002 |
| 4014 | Invalid Accept header | 4 | 0 | ERROR | 400 | 3000 |
| 4015 | You must provide at least one indexed property | 4 | 0 | ERROR | 400 | 3000 |
| 4016 | The depth parameter must be a number or the string "all" | 4 | 0 | ERROR | 400 | 3000 |
| 4017 | Could not set property | 5 | 2 | INFO | 400 | 3000 |
| 5101 | Could not connect to database | 5 | 4 | FATAL | 500 | 3002 |
| 5102 | Graph database is null after open | 5 | 4 | FATAL | 500 | 3002 |
| 5103 | Unexpected error during commit | 5 | 4 | ERROR | 500 | 3002 |
| 5104 | Unexpected error during rollback | 5 | 4 | ERROR | 500 | 3002 |
| 5105 | Unexpected error reading/updating database | 5 | 4 | ERROR | 500 | 3002 |
| 5106 | Node not found | 5 | 4 | WARN | 404 | 3001 |
| 5107 | Required information missing | 5 | 2 | WARN | 400 | 3000 |
| 5108 | Unexpected information in request being ignored | 5 | 2 | WARN | 200 | 0 |
| 6101 | null TitanGraph object passed | 5 | 4 | ERROR | 500 | 3002 |
| 6102 | Passed-in property is not valid for this nodeType | 5 | 4 | WARN | 400 | 3000 |
| 6103 | Required Node-property not found in input data | 5 | 4 | WARN | 400 | 3000 |
| 6104 | Required Node-property was passed with no data | 5 | 4 | WARN | 400 | 3000 |
| 6105 | Node-Key-Property not defined in DbMaps | 5 | 4 | WARN | 400 | 3000 |
| 6106 | Passed-in property is not valid for this edgeType | 5 | 4 | WARN | 400 | 3000 |
| 6107 | Required Edge-property not found in input data | 5 | 4 | WARN | 400 | 3000 |
| 6108 | Required Edge-property was passed with no data | 5 | 4 | WARN | 400 | 3000 |
| 6109 | Bad dependent Node value | 5 | 4 | WARN | 400 | 3000 |
| 6110 | Node cannot be deleted | 5 | 4 | ERROR | 400 | 3100 |
| 6111 | JSON processing error | 5 | 4 | ERROR | 400 | 3000 |
| 6112 | More than one node found by getUniqueNode() | 5 | 4 | ERROR | 400 | 3000 |
| Node Not Found | 5 | 4 | INFO | 404 | 3001 | |
| 6115 | Unrecognized NodeType | 5 | 4 | ERROR | 400 | 3000 |
| 6116 | Unrecognized Property | 5 | 4 | ERROR | 400 | 3000 |
| 6117 | Uniqueness constraint violated | 5 | 4 | ERROR | 400 | 3000 |
| 6118 | Required Field not passed. | 5 | 4 | ERROR | 400 | 3000 |
| 6120 | Bad Parameter Passed | 5 | 4 | ERROR | 400 | 3000 |
| 6121 | Problem with internal AAI reference data | 5 | 4 | ERROR | 400 | 3000 |
| 6122 | Data Set not complete in DB for this request | 5 | 4 | ERROR | 400 | 3000 |
| 6123 | Bad Data found by DataGrooming Tool - Investigate | 5 | 4 | ERROR | 500 | 3000 |
| 6124 | File read/write error | 5 | 4 | ERROR | 500 | 3000 |
| 6125 | Problem Pulling Data Set | 5 | 4 | WARN | 500 | 3000 |
| 6126 | Edge cannot be deleted | 5 | 4 | ERROR | 400 | 3000 |
| 6127 | Edge Not Found | 5 | 4 | INFO | 404 | 3001 |
| 6128 | Unexpected error | 5 | 4 | INFO | 500 | 3000 |
| 6129 | Error making edge to target node | 5 | 4 | INFO | 404 | 3003 |
| 6130 | Precondition Required | 5 | 4 | WARN | 412 | 3000 |
| 6131 | Precondition Failed | 5 | 4 | WARN | 412 | 3000 |
| 6132 | Bad Model Definition | 5 | 4 | WARN | 400 | 3000 |
| 6133 | Bad Named Query Definition | 5 | 4 | WARN | 400 | 3000 |
| 6134 | Could not persist transaction to storage back end. Exhausted retry amount | 5 | 4 | ERROR | 413 | 6134 |
| 6135 | Resource version specified on create | 5 | 4 | WARN | 412 | 3000 |
| 6136 | Object cannot hold multiple items | 5 | 4 | ERROR | 400 | 3000 |
| 6137 | Cannot perform writes on multiple vertices | 5 | 4 | ERROR | 400 | 3000 |
| 6138 | Cannot delete multiple vertices | 5 | 4 | ERROR | 400 | 3000 |
| 6139 | Attempted to add edge to vertex that does not exist | 5 | 4 | ERROR | 404 | 3000 |
| 6140 | Edge multiplicity violated | 5 | 4 | ERROR | 400 | 3000 |
| 6141 | Please Refine Query | 5 | 4 | WARN | 400 | 3000 |
| 6142 | Retrying transaction | 5 | 4 | INFO | 400 | 3000 |
| 6143 | Ghost vertex found | 5 | 4 | INFO | 400 | 3000 |
| 6144 | Cycle found in graph | 5 | 4 | WARN | 400 | 3000 |
| 6145 | Cannot create a nested/containment edge via relationship | 5 | 4 | ERROR | 400 | 3000 |
| 7115 | Unexpected error | 5 | 4 | ERROR | 500 | 3002 |
| 7116 | Request error | 5 | 4 | ERROR | 500 | 3002 |
| 7117 | Error in get http client object | 5 | 4 | ERROR | 500 | 3002 |
| 7301 | Error getting connection to UEB | 5 | 4 | ERROR | 500 | 3002 |
| 7302 | Unexpected error | 5 | 4 | ERROR | 500 | 3002 |
| 7303 | Request error | 5 | 4 | ERROR | 500 | 3002 |
| 7304 | UEB server has a problem | 5 | 4 | ERROR | 500 | 3002 |
| 7305 | Error processing data in HBase notification table | 5 | 4 | FATAL | 500 | 3002 |
| 7306 | Error create HBase table connection | 5 | 4 | FATAL | 500 | 3002 |
| 7307 | Problem found while monitoring UEB publisher | 5 | 4 | FATAL | 500 | 3002 |
| 7305 | Notification event creation failed | 5 | 4 | ERROR | 500 | 3002 |
| 7401 | Error connecting to AAI REST API | 5 | 4 | ERROR | 500 | 3002 |
| 7402 | Unexpected error | 5 | 4 | ERROR | 500 | 3002 |
| 7403 | Request error | 5 | 4 | WARN | 400 | 3001 |
| 7404 | Node not found | 5 | 4 | INFO | 404 | 3001 |