Version: v21
Copyright © 2017-18 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.
This document is best viewed with Firefox or Chrome. Nodes can be found by opening the models link below and finding the node-type. Edge definitions can be found with the node definitions.
returns connectors
resource-instance-id |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
widget-model-id |
n/a |
query | string | |
widget-model-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns connector
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing connector
application/json application/xml
connector object that needs to be created or updated.
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing connector
application/json application/xml
connector object that needs to be updated.
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing connector
application/json application/xml
resource-instance-id |
Unique id of resource instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing metadatum
application/json application/xml
metadatum object that needs to be created or updated.
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
update an existing metadatum
application/json application/xml
metadatum object that needs to be updated.
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
resource-instance-id |
Unique id of resource instance. |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
resource-instance-id |
Unique id of resource instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns customers
global-customer-id |
n/a |
query | string | |
subscriber-name |
n/a |
query | string | |
subscriber-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns customer
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | 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 ONAP to uniquely identify customer. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing customer
application/json application/xml
customer object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing customer
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP 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 ONAP 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 ONAP to uniquely identify customer. |
path | string | |
service-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service-subscription
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | 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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing service-subscription
application/json application/xml
service-subscription object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-subscription
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string |
application/json application/xml
Response codes found in response codes.
returns service-instances
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
n/a |
query | string | |
service-instance-name |
n/a |
query | string | |
environment-context |
n/a |
query | string | |
workload-context |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
widget-model-id |
n/a |
query | string | |
widget-model-version |
n/a |
query | string | |
service-instance-location-id |
n/a |
query | string | |
orchestration-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service-instance
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | 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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing service-instance
application/json application/xml
service-instance object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-instance
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
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 allotted-resources
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
type |
n/a |
query | string | |
role |
n/a |
query | string | |
allotted-resource-name |
n/a |
query | string | |
access-provider-id |
n/a |
query | string | |
access-client-id |
n/a |
query | string | |
access-topology-id |
n/a |
query | string | |
access-node-id |
n/a |
query | string | |
access-ltp-id |
n/a |
query | string | |
vpn-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns allotted-resource
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing allotted-resource
application/json application/xml
allotted-resource object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing allotted-resource
application/json application/xml
allotted-resource object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing allotted-resource
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string |
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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns tunnel-xconnects
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns tunnel-xconnect
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
tunnel-xconnect.id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing tunnel-xconnect
application/json application/xml
tunnel-xconnect object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
tunnel-xconnect.id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing tunnel-xconnect
application/json application/xml
tunnel-xconnect object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
tunnel-xconnect.id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing tunnel-xconnect
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
tunnel-xconnect.id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
tunnel-xconnect.id |
Allotted Resource 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
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
id |
Allotted Resource id UUID assigned to this instance. |
path | string | |
tunnel-xconnect.id |
Allotted Resource id UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns communication-service-profiles
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns communication-service-profile
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing communication-service-profile
application/json application/xml
communication-service-profile object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing communication-service-profile
application/json application/xml
communication-service-profile object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing communication-service-profile
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
returns metadata
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname | path | 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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
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.
update an existing metadatum
application/json application/xml
metadatum object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
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 service-profiles
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service-profile
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing service-profile
application/json application/xml
service-profile object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing service-profile
application/json application/xml
service-profile object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-profile
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
returns slice-profiles
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns slice-profile
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing slice-profile
application/json application/xml
slice-profile object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing slice-profile
application/json application/xml
slice-profile object that needs to be updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing slice-profile
application/json application/xml
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
global-customer-id |
Global customer id used across ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
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 ONAP to uniquely identify customer. |
path | string | |
service-type |
Value defined by orchestration to identify this service across ONAP. |
path | string | |
service-instance-id |
Uniquely identifies this instance of a service |
path | string | |
profile-id |
ID of the profile. |
path | string |
application/json application/xml
Response codes found in response codes.
returns lines-of-business
line-of-business-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns line-of-business
line-of-business-name |
Name of the line-of-business (product) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing line-of-business
application/json application/xml
line-of-business object that needs to be created or updated.
line-of-business-name |
Name of the line-of-business (product) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing line-of-business
application/json application/xml
line-of-business object that needs to be updated.
line-of-business-name |
Name of the line-of-business (product) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing line-of-business
application/json application/xml
line-of-business-name |
Name of the line-of-business (product) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
line-of-business-name |
Name of the line-of-business (product) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
line-of-business-name |
Name of the line-of-business (product) |
path | string |
application/json application/xml
Response codes found in response codes.
returns owning-entities
owning-entity-id |
n/a |
query | string | |
owning-entity-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns owning-entity
owning-entity-id |
UUID of an owning entity |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing owning-entity
application/json application/xml
owning-entity object that needs to be created or updated.
owning-entity-id |
UUID of an owning entity |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing owning-entity
application/json application/xml
owning-entity object that needs to be updated.
owning-entity-id |
UUID of an owning entity |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing owning-entity
application/json application/xml
owning-entity-id |
UUID of an owning entity |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
owning-entity-id |
UUID of an owning entity |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
owning-entity-id |
UUID of an owning entity |
path | string |
application/json application/xml
Response codes found in response codes.
returns platforms
platform-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns platform
platform-name |
Name of the platform |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing platform
application/json application/xml
platform object that needs to be created or updated.
platform-name |
Name of the platform |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing platform
application/json application/xml
platform object that needs to be updated.
platform-name |
Name of the platform |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing platform
application/json application/xml
platform-name |
Name of the platform |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
platform-name |
Name of the platform |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
platform-name |
Name of the platform |
path | string |
application/json application/xml
Response codes found in response codes.
returns projects
project-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns project
project-name |
Name of the project deploying a service |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing project
application/json application/xml
project object that needs to be created or updated.
project-name |
Name of the project deploying a service |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing project
application/json application/xml
project object that needs to be updated.
project-name |
Name of the project deploying a service |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing project
application/json application/xml
project-name |
Name of the project deploying a service |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
project-name |
Name of the project deploying a service |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
project-name |
Name of the project deploying a service |
path | string |
application/json application/xml
Response codes found in response codes.
returns sp-partners
sp-partner-id |
n/a |
query | string | |
url |
n/a |
query | string | |
callsource |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sp-partner
sp-partner-id |
Uniquely identifies this sp-partner by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sp-partner
application/json application/xml
sp-partner object that needs to be created or updated.
sp-partner-id |
Uniquely identifies this sp-partner by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sp-partner
application/json application/xml
sp-partner object that needs to be updated.
sp-partner-id |
Uniquely identifies this sp-partner by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sp-partner
application/json application/xml
sp-partner-id |
Uniquely identifies this sp-partner by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
sp-partner-id |
Uniquely identifies this sp-partner by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
sp-partner-id |
Uniquely identifies this sp-partner by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns cloud-regions
cloud-owner |
n/a |
query | string | |
cloud-region-id |
n/a |
query | string | |
cloud-type |
n/a |
query | string | |
owner-defined-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns cloud-region
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
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.
update an existing cloud-region
application/json application/xml
cloud-region object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing cloud-region
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
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 | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
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 | |
activity-id |
Unique id for the activity. (UUID) |
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 | |
activity-id |
Unique id for the activity. (UUID) |
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 | |
availability-zone-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns availability-zone
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
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.
update an existing availability-zone
application/json application/xml
availability-zone object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing availability-zone
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
availability-zone-name |
Name of the availability zone. Unique across a cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
returns dvs-switches
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
n/a |
query | string | |
vcenter-url |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns dvs-switch
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing dvs-switch
application/json application/xml
dvs-switch object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing dvs-switch
application/json application/xml
dvs-switch object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing dvs-switch
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
switch-name |
DVS switch name |
path | string |
application/json application/xml
Response codes found in response codes.
returns esr-system-info-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 | |
esr-system-info-id |
n/a |
query | string | |
system-name |
n/a |
query | string | |
system-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-system-info
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 | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-system-info
application/json application/xml
esr-system-info 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 | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be 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 | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-system-info
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 | |
esr-system-info-id |
Unique ID of esr system info. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
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 | |
esr-system-info-id |
Unique ID of esr system info. |
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 | |
flavor-id |
n/a |
query | string | |
flavor-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns flavor
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
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.
update an existing flavor
application/json application/xml
flavor object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing flavor
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns hpa-capabilities
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
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 | |
hpa-capability-id |
n/a |
query | string | |
hpa-feature |
n/a |
query | string | |
architecture |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns hpa-capability
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hpa-capability
application/json application/xml
hpa-capability 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hpa-capability
application/json application/xml
hpa-capability object that needs to be 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hpa-capability
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns hpa-feature-attributes
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hpa-feature-attributes
application/json application/xml
hpa-feature-attributes 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hpa-feature-attributes
application/json application/xml
hpa-feature-attributes object that needs to be 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hpa-feature-attributes
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
flavor-id |
Flavor id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
returns group-assignments
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
n/a |
query | string | |
group-type |
n/a |
query | string | |
group-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns group-assignment
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
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.
update an existing group-assignment
application/json application/xml
group-assignment object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing group-assignment
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
group-id |
Group id, expected to be unique across cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
returns host-aggregates
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 | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns host-aggregate
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 | |
host-aggregate-id |
Unique identifier for the host-aggregate. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing host-aggregate
application/json application/xml
host-aggregate 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 | |
host-aggregate-id |
Unique identifier for the host-aggregate. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing host-aggregate
application/json application/xml
host-aggregate object that needs to be 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 | |
host-aggregate-id |
Unique identifier for the host-aggregate. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing host-aggregate
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 | |
host-aggregate-id |
Unique identifier for the host-aggregate. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
host-aggregate-id |
Unique identifier for the host-aggregate. |
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 | |
host-aggregate-id |
Unique identifier for the host-aggregate. |
path | string |
application/json application/xml
Response codes found in response codes.
returns hpa-capabilities
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
hpa-capability-id |
n/a |
query | string | |
hpa-feature |
n/a |
query | string | |
architecture |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns hpa-capability
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hpa-capability
application/json application/xml
hpa-capability 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hpa-capability
application/json application/xml
hpa-capability object that needs to be 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hpa-capability
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns hpa-feature-attributes
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hpa-feature-attributes
application/json application/xml
hpa-feature-attributes 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hpa-feature-attributes
application/json application/xml
hpa-feature-attributes object that needs to be 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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hpa-feature-attributes
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
path | string | |
hpa-attribute-key |
name of the specific HPA attribute |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
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 | |
hpa-capability-id |
UUID to uniquely identify a HPA capability |
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 | |
image-id |
n/a |
query | string | |
image-name |
n/a |
query | string | |
application |
n/a |
query | string | |
application-vendor |
n/a |
query | string | |
application-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns image
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
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.
update an existing image
application/json application/xml
image object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing image
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname | path | string |
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.
update an existing metadatum
application/json application/xml
metadatum object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
image-id |
Image id, expected to be unique across cloud region |
path | string |
application/json application/xml
Response codes found in response codes.
returns oam-networks
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
n/a |
query | string | |
network-name |
n/a |
query | string | |
cvlan-tag |
n/a |
query | integer |
application/json application/xml
successful operation
Response codes found in response codes.
returns oam-network
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing oam-network
application/json application/xml
oam-network object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing oam-network
application/json application/xml
oam-network object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing oam-network
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
network-uuid |
UUID of the network. Unique across a cloud-region |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string |
application/json application/xml
Response codes found in response codes.
returns snapshots
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
n/a |
query | string | |
snapshot-name |
n/a |
query | string | |
application |
n/a |
query | string | |
application-vendor |
n/a |
query | string | |
application-version |
n/a |
query | string | |
prev-snapshot-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns snapshot
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
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.
update an existing snapshot
application/json application/xml
snapshot object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing snapshot
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
snapshot-id |
Snapshot id, this is the key UUID assoc associated in glance with the snapshots. |
path | string |
application/json application/xml
Response codes found in response codes.
returns tenants
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
n/a |
query | string | |
tenant-name |
n/a |
query | string | |
tenant-context |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns tenant
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
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.
update an existing tenant
application/json application/xml
tenant object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing tenant
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns nos-servers
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 | |
nos-server-id |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns nos-server
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 | |
nos-server-id |
Unique identifier for this nos relative to its tenant |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing nos-server
application/json application/xml
nos-server 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 | |
nos-server-id |
Unique identifier for this nos relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing nos-server
application/json application/xml
nos-server object that needs to be 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 | |
nos-server-id |
Unique identifier for this nos relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing nos-server
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 | |
nos-server-id |
Unique identifier for this nos relative to its tenant |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
nos-server-id |
Unique identifier for this nos relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
nos-server-id |
Unique identifier for this nos relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vservers
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
n/a |
query | string | |
vserver-name |
n/a |
query | string | |
vserver-name2 |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
is-closed-loop-disabled |
n/a |
query | boolean |
application/json application/xml
successful operation
Response codes found in response codes.
returns vserver
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
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.
update an existing vserver
application/json application/xml
vserver object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vserver
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
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.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string |
application/json application/xml
Response codes found in response codes.
returns volumes
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns volume
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
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.
update an existing volume
application/json application/xml
volume object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing volume
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
tenant-id |
Unique id relative to the cloud-region. |
path | string | |
vserver-id |
Unique identifier for this vserver relative to its tenant |
path | string | |
volume-id |
Unique ID of block storage volume relative to the vserver. |
path | string |
application/json application/xml
Response codes found in response codes.
returns validation-audits
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 | |
validation-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns validation-audit
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 | |
validation-id |
Validation-Audit UUID |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing validation-audit
application/json application/xml
validation-audit 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 | |
validation-id |
Validation-Audit UUID |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing validation-audit
application/json application/xml
validation-audit object that needs to be 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 | |
validation-id |
Validation-Audit UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing validation-audit
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 | |
validation-id |
Validation-Audit UUID |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
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 | |
validation-id |
Validation-Audit UUID |
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 | |
validation-id |
Validation-Audit UUID |
path | string |
application/json application/xml
Response codes found in response codes.
returns vip-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 | |
vip-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vip-ipv4-address-list
application/json application/xml
vip-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 | |
vip-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vip-ipv4-address-list
application/json application/xml
vip-ipv4-address-list object that needs to be 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 | |
vip-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vip-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 | |
vip-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
vip-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 | |
vip-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns vip-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 | |
vip-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vip-ipv6-address-list
application/json application/xml
vip-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 | |
vip-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vip-ipv6-address-list
application/json application/xml
vip-ipv6-address-list object that needs to be 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 | |
vip-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vip-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 | |
vip-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
vip-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 | |
vip-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlan-ranges
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 | |
vlan-range-id |
n/a |
query | string | |
vlan-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan-range
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 | |
vlan-range-id |
vlan id in range UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan-range
application/json application/xml
vlan-range 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 | |
vlan-range-id |
vlan id in range UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vlan-range
application/json application/xml
vlan-range object that needs to be 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 | |
vlan-range-id |
vlan id in range UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan-range
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 | |
vlan-range-id |
vlan id in range UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
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 | |
vlan-range-id |
vlan id in range UUID. |
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 | |
vlan-range-id |
vlan id in range UUID. |
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 | |
volume-group-id |
n/a |
query | string | |
volume-group-name |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string | |
vnf-type |
n/a |
query | string | |
orchestration-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns volume-group
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
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.
update an existing volume-group
application/json application/xml
volume-group object that needs to be updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing volume-group
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
cloud-owner |
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname |
path | string | |
cloud-region-id |
Identifier used by the vendor for the region. Second part of composite key |
path | string | |
volume-group-id |
Unique ID of volume-group. |
path | string |
application/json application/xml
Response codes found in response codes.
returns complexes
physical-location-id |
n/a |
query | string | |
data-center-code |
n/a |
query | string | |
complex-name |
n/a |
query | string | |
identity-url |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns complex
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing complex
application/json application/xml
complex object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing complex
application/json application/xml
complex object that needs to be updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing complex
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns cables
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns cable
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
A unique name for the channel-link relative to the physical-link. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing cable
application/json application/xml
cable object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
A unique name for the channel-link relative to the physical-link. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing cable
application/json application/xml
cable object that needs to be updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
A unique name for the channel-link relative to the physical-link. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing cable
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
A unique name for the channel-link relative to the physical-link. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
A unique name for the channel-link relative to the physical-link. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
cable-name |
A unique name for the channel-link relative to the physical-link. |
path | string |
application/json application/xml
Response codes found in response codes.
returns ctag-pools
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
availability-zone-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns ctag-pool
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ctag-pool
application/json application/xml
ctag-pool object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing ctag-pool
application/json application/xml
ctag-pool object that needs to be updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing ctag-pool
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
target-pe |
The Target provider edge router |
path | string | |
availability-zone-name |
Name of the availability zone |
path | string |
application/json application/xml
Response codes found in response codes.
returns racks
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns rack
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing rack
application/json application/xml
rack object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing rack
application/json application/xml
rack object that needs to be updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing rack
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns pdus
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pdu
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
A unique name for the power distribution unit. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pdu
application/json application/xml
pdu object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
A unique name for the power distribution unit. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing pdu
application/json application/xml
pdu object that needs to be updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
A unique name for the power distribution unit. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pdu
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
A unique name for the power distribution unit. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
A unique name for the power distribution unit. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
pdu-name |
A unique name for the power distribution unit. |
path | string |
application/json application/xml
Response codes found in response codes.
returns rack-units
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns rack-unit
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
A unique name for the rack-unit (within the rack). |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing rack-unit
application/json application/xml
rack-unit object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
A unique name for the rack-unit (within the rack). |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing rack-unit
application/json application/xml
rack-unit object that needs to be updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
A unique name for the rack-unit (within the rack). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing rack-unit
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
A unique name for the rack-unit (within the rack). |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
A unique name for the rack-unit (within the rack). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string | |
rack-unit-name |
A unique name for the rack-unit (within the rack). |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string | |
rack-name |
A unique name for the rack (within the location). |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
physical-location-id |
Unique identifier for physical location, e.g., CLLI |
path | string |
application/json application/xml
Response codes found in response codes.
returns geo-regions
geo-region-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns geo-region
geo-region-id |
UUID, key for geo-region object. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing geo-region
application/json application/xml
geo-region object that needs to be created or updated.
geo-region-id |
UUID, key for geo-region object. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing geo-region
application/json application/xml
geo-region object that needs to be updated.
geo-region-id |
UUID, key for geo-region object. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing geo-region
application/json application/xml
geo-region-id |
UUID, key for geo-region object. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
geo-region-id |
UUID, key for geo-region object. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
geo-region-id |
UUID, key for geo-region object. |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-profiles
nm-profile-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns network-profile
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-profile
application/json application/xml
network-profile object that needs to be created or updated.
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing network-profile
application/json application/xml
network-profile object that needs to be updated.
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-profile
application/json application/xml
nm-profile-name |
Unique name of network profile. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
nm-profile-name |
Unique name of network profile. |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-technologies
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns network-technology
network-technology-id |
Unique identifier of the network-technology object (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-technology
application/json application/xml
network-technology object that needs to be created or updated.
network-technology-id |
Unique identifier of the network-technology object (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing network-technology
application/json application/xml
network-technology object that needs to be updated.
network-technology-id |
Unique identifier of the network-technology object (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-technology
application/json application/xml
network-technology-id |
Unique identifier of the network-technology object (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-technology-id |
Unique identifier of the network-technology object (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-technology-id |
Unique identifier of the network-technology object (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
returns operational-environments
operational-environment-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns operational-environment
operational-environment-id |
UUID of an operational environment |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing operational-environment
application/json application/xml
operational-environment object that needs to be created or updated.
operational-environment-id |
UUID of an operational environment |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing operational-environment
application/json application/xml
operational-environment object that needs to be updated.
operational-environment-id |
UUID of an operational environment |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing operational-environment
application/json application/xml
operational-environment-id |
UUID of an operational environment |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
operational-environment-id |
UUID of an operational environment |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
operational-environment-id |
UUID of an operational environment |
path | string |
application/json application/xml
Response codes found in response codes.
returns pservers
hostname |
n/a |
query | string | |
ptnii-equip-name |
n/a |
query | string | |
fqdn |
n/a |
query | string | |
inv-status |
n/a |
query | string | |
pserver-id |
n/a |
query | string | |
pserver-name2 |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pserver
hostname |
Value from executing hostname on the compute node. |
path | string |
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.
update an existing pserver
application/json application/xml
pserver object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pserver
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
hostname |
Value from executing hostname on the compute node. |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
returns hpa-capacity
hostname |
Value from executing hostname on the compute node. |
path | string | |
hpa-capacity-key |
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hpa-capacity
application/json application/xml
hpa-capacity object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
hpa-capacity-key |
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hpa-capacity
application/json application/xml
hpa-capacity object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
hpa-capacity-key |
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hpa-capacity
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
hpa-capacity-key |
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
hpa-capacity-key |
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check |
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 | |
hpa-capacity-key |
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check |
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 |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | 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 given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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
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 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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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
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 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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name 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 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
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
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.
update an existing lag-interface
application/json application/xml
lag-interface object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | 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 | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.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 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 | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns p-interfaces
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
n/a |
query | string | |
interface-name2 |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
network-ref |
n/a |
query | string | |
operational-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns p-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
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.
update an existing p-interface
application/json application/xml
p-interface object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing p-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
returns bandwidth-attributes
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bandwidth-attribute
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bandwidth-attribute
application/json application/xml
bandwidth-attribute 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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bandwidth-attribute
application/json application/xml
bandwidth-attribute object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bandwidth-attribute
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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns available-bandwidth-map
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns available-bandwidth
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing available-bandwidth
application/json application/xml
available-bandwidth 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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing available-bandwidth
application/json application/xml
available-bandwidth object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing available-bandwidth
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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
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 | |
bwa-id |
Id that identifies the bandwidth attribute |
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 | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | 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 | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.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 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 | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
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.
returns sriov-pfs
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-pf
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-pf
application/json application/xml
sriov-pf 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 | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-pf
application/json application/xml
sriov-pf object that needs to be updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-pf
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 | |
pf-pci-id |
Identifier for the sriov-pf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
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 | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hostname |
Value from executing hostname on the compute node. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hostname |
Value from executing hostname on the compute node. |
path | string |
application/json application/xml
Response codes found in response codes.
returns virtual-data-centers
vdc-id |
n/a |
query | string | |
vdc-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns virtual-data-center
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing virtual-data-center
application/json application/xml
virtual-data-center object that needs to be created or updated.
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing virtual-data-center
application/json application/xml
virtual-data-center object that needs to be updated.
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing virtual-data-center
application/json application/xml
vdc-id |
Unique ID of the vdc |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vdc-id |
Unique ID of the vdc |
path | string |
application/json application/xml
Response codes found in response codes.
returns contacts
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns contact
contact-name |
Name of the contact |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing contact
application/json application/xml
contact object that needs to be created or updated.
contact-name |
Name of the contact |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing contact
application/json application/xml
contact object that needs to be updated.
contact-name |
Name of the contact |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing contact
application/json application/xml
contact-name |
Name of the contact |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
contact-name |
Name of the contact |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
contact-name |
Name of the contact |
path | string |
application/json application/xml
Response codes found in response codes.
returns hardware-catalog-items
item-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns hardware-catalog-item
item-name |
Unique name for the hardware-catalog-item |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hardware-catalog-item
application/json application/xml
hardware-catalog-item object that needs to be created or updated.
item-name |
Unique name for the hardware-catalog-item |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hardware-catalog-item
application/json application/xml
hardware-catalog-item object that needs to be updated.
item-name |
Unique name for the hardware-catalog-item |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hardware-catalog-item
application/json application/xml
item-name |
Unique name for the hardware-catalog-item |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
item-name |
Unique name for the hardware-catalog-item |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
item-name |
Unique name for the hardware-catalog-item |
path | string |
application/json application/xml
Response codes found in response codes.
returns policies
policy-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns policy
policy-id |
Unique Policy UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing policy
application/json application/xml
policy object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing policy
application/json application/xml
policy object that needs to be updated.
policy-id |
Unique Policy UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing policy
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns rules
policy-id |
Unique Policy UUID. |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns rule
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing rule
application/json application/xml
rule object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing rule
application/json application/xml
rule object that needs to be updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing rule
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns port-list
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
port |
Port number |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port-list
application/json application/xml
port-list object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
port |
Port number |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing port-list
application/json application/xml
port-list object that needs to be updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
port |
Port number |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port-list
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
port |
Port number |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
port |
Port number |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
port |
Port number |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns selector-list
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing selector-list
application/json application/xml
selector-list object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing selector-list
application/json application/xml
selector-list object that needs to be updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing selector-list
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
selector |
Selector |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
rule-id |
UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
returns selector-list
policy-id |
Unique Policy UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing selector-list
application/json application/xml
selector-list object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing selector-list
application/json application/xml
selector-list object that needs to be updated.
policy-id |
Unique Policy UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing selector-list
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
selector |
Selector |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
policy-id |
Unique Policy UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
policy-id |
Unique Policy UUID. |
path | string | |
selector |
Selector |
path | string |
application/json application/xml
Response codes found in response codes.
returns profiles
profile-name |
n/a |
query | string | |
profile-role |
n/a |
query | string | |
profile-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns profile
profile-name |
Name of the profile |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing profile
application/json application/xml
profile object that needs to be created or updated.
profile-name |
Name of the profile |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing profile
application/json application/xml
profile object that needs to be updated.
profile-name |
Name of the profile |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing profile
application/json application/xml
profile-name |
Name of the profile |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
profile-name |
Name of the profile |
path | string | |
metaname |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
profile-name |
Name of the profile |
path | string | |
metaname | path | 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.
profile-name |
Name of the profile |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
update an existing metadatum
application/json application/xml
metadatum object that needs to be updated.
profile-name |
Name of the profile |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
profile-name |
Name of the profile |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
profile-name |
Name of the profile |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
profile-name |
Name of the profile |
path | string |
application/json application/xml
Response codes found in response codes.
returns relationship-rules
rule-id |
n/a |
query | string | |
context |
n/a |
query | string | |
rule-traversals |
n/a |
query | integer | |
applies-to |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns relationship-rule
rule-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing relationship-rule
application/json application/xml
relationship-rule object that needs to be created or updated.
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing relationship-rule
application/json application/xml
relationship-rule object that needs to be updated.
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship-rule
application/json application/xml
rule-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns relationship-components
rule-id |
UUID. |
path | string | |
rule-node |
n/a |
query | string | |
rule-property |
n/a |
query | string | |
rule-value |
n/a |
query | string | |
component-order |
n/a |
query | integer |
application/json application/xml
successful operation
Response codes found in response codes.
returns relationship-component
rule-id |
UUID. |
path | string | |
rule-node |
NARAD object |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing relationship-component
application/json application/xml
relationship-component object that needs to be created or updated.
rule-id |
UUID. |
path | string | |
rule-node |
NARAD object |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing relationship-component
application/json application/xml
relationship-component object that needs to be updated.
rule-id |
UUID. |
path | string | |
rule-node |
NARAD object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship-component
application/json application/xml
rule-id |
UUID. |
path | string | |
rule-node |
NARAD object |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
rule-id |
UUID. |
path | string | |
rule-node |
NARAD object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
rule-id |
UUID. |
path | string | |
rule-node |
NARAD object |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
rule-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlan-characteristics
vlan-characteristic-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan-characteristic
vlan-characteristic-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan-characteristic
application/json application/xml
vlan-characteristic object that needs to be created or updated.
vlan-characteristic-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vlan-characteristic
application/json application/xml
vlan-characteristic object that needs to be updated.
vlan-characteristic-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan-characteristic
application/json application/xml
vlan-characteristic-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vlan-characteristic-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vlan-characteristic-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns esr-ems-list
ems-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-ems
ems-id |
Unique ID of EMS. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-ems
application/json application/xml
esr-ems object that needs to be created or updated.
ems-id |
Unique ID of EMS. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-ems
application/json application/xml
esr-ems object that needs to be updated.
ems-id |
Unique ID of EMS. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-ems
application/json application/xml
ems-id |
Unique ID of EMS. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns esr-system-info-list
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
n/a |
query | string | |
system-name |
n/a |
query | string | |
system-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-system-info
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be created or updated.
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be updated.
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-system-info
application/json application/xml
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ems-id |
Unique ID of EMS. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
ems-id |
Unique ID of EMS. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ems-id |
Unique ID of EMS. |
path | string |
application/json application/xml
Response codes found in response codes.
returns esr-nfvo-list
nfvo-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-nfvo
nfvo-id |
Unique ID of nfvo. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-nfvo
application/json application/xml
esr-nfvo object that needs to be created or updated.
nfvo-id |
Unique ID of nfvo. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-nfvo
application/json application/xml
esr-nfvo object that needs to be updated.
nfvo-id |
Unique ID of nfvo. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-nfvo
application/json application/xml
nfvo-id |
Unique ID of nfvo. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns esr-system-info-list
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
n/a |
query | string | |
system-name |
n/a |
query | string | |
system-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-system-info
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be created or updated.
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be updated.
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-system-info
application/json application/xml
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
nfvo-id |
Unique ID of nfvo. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
nfvo-id |
Unique ID of nfvo. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
nfvo-id |
Unique ID of nfvo. |
path | string |
application/json application/xml
Response codes found in response codes.
returns esr-thirdparty-sdnc-list
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-thirdparty-sdnc
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-thirdparty-sdnc
application/json application/xml
esr-thirdparty-sdnc object that needs to be created or updated.
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-thirdparty-sdnc
application/json application/xml
esr-thirdparty-sdnc object that needs to be updated.
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-thirdparty-sdnc
application/json application/xml
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns esr-system-info-list
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
n/a |
query | string | |
system-name |
n/a |
query | string | |
system-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-system-info
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be created or updated.
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be updated.
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-system-info
application/json application/xml
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
thirdparty-sdnc-id |
Unique ID of SDNC. |
path | string |
application/json application/xml
Response codes found in response codes.
returns esr-vnfm-list
vnfm-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-vnfm
vnfm-id |
Unique ID of VNFM. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-vnfm
application/json application/xml
esr-vnfm object that needs to be created or updated.
vnfm-id |
Unique ID of VNFM. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-vnfm
application/json application/xml
esr-vnfm object that needs to be updated.
vnfm-id |
Unique ID of VNFM. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-vnfm
application/json application/xml
vnfm-id |
Unique ID of VNFM. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns esr-system-info-list
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
n/a |
query | string | |
system-name |
n/a |
query | string | |
system-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns esr-system-info
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be created or updated.
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be updated.
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-system-info
application/json application/xml
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnfm-id |
Unique ID of VNFM. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfm-id |
Unique ID of VNFM. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnfm-id |
Unique ID of VNFM. |
path | string |
application/json application/xml
Response codes found in response codes.
returns autonomous-systems
autonomous-system-id |
n/a |
query | string | |
autonomous-system-number |
n/a |
query | integer | |
autonomous-system-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns autonomous-system
autonomous-system-id |
UUID |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing autonomous-system
application/json application/xml
autonomous-system object that needs to be created or updated.
autonomous-system-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing autonomous-system
application/json application/xml
autonomous-system object that needs to be updated.
autonomous-system-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing autonomous-system
application/json application/xml
autonomous-system-id |
UUID |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
autonomous-system-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
autonomous-system-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
returns bfds
bfd-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bfd
bfd-id |
Unique identifier. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bfd
application/json application/xml
bfd object that needs to be created or updated.
bfd-id |
Unique identifier. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bfd
application/json application/xml
bfd object that needs to be updated.
bfd-id |
Unique identifier. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bfd
application/json application/xml
bfd-id |
Unique identifier. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
bfd-id |
Unique identifier. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
bfd-id |
Unique identifier. |
path | string |
application/json application/xml
Response codes found in response codes.
returns chassies
chassis-name |
n/a |
query | string | |
part-number |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
equip-model |
n/a |
query | string | |
equip-vendor |
n/a |
query | string | |
equip-identifier |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns chassis
chassis-name |
A globally unique name for the chassis. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing chassis
application/json application/xml
chassis object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing chassis
application/json application/xml
chassis object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing chassis
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns card-slots
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns card-slot
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing card-slot
application/json application/xml
card-slot object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing card-slot
application/json application/xml
card-slot object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing card-slot
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns cards
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns card
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing card
application/json application/xml
card object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing card
application/json application/xml
card object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing card
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns pluggable-slots
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
slot-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pluggable-slot
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pluggable-slot
application/json application/xml
pluggable-slot object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing pluggable-slot
application/json application/xml
pluggable-slot object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pluggable-slot
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns pluggables
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
n/a |
query | string | |
part-number |
n/a |
query | string | |
equip-identifier |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pluggable
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pluggable
application/json application/xml
pluggable object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing pluggable
application/json application/xml
pluggable object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pluggable
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns ports
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns port
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port
application/json application/xml
port object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing port
application/json application/xml
port object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
pluggable-slot.slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
returns ports
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns port
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port
application/json application/xml
port object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing port
application/json application/xml
port object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string | |
card-type |
The type of card. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the card-slot (unique relative to the chassis). |
path | string |
application/json application/xml
Response codes found in response codes.
returns licenses
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
n/a |
query | string | |
resource-uuid |
n/a |
query | string | |
project-number |
n/a |
query | string | |
order-number |
n/a |
query | string | |
receipt-date |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns license
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing license
application/json application/xml
license object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing license
application/json application/xml
license object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing license
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
returns pluggable-slots
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pluggable-slot
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pluggable-slot
application/json application/xml
pluggable-slot object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing pluggable-slot
application/json application/xml
pluggable-slot object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pluggable-slot
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns pluggables
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
n/a |
query | string | |
part-number |
n/a |
query | string | |
equip-identifier |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pluggable
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing pluggable
application/json application/xml
pluggable object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing pluggable
application/json application/xml
pluggable object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pluggable
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns ports
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns port
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port
application/json application/xml
port object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing port
application/json application/xml
port object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string | |
pluggable-type |
The type of pluggable. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
slot-name |
The name of the pluggable-slot. (unique relative to the chassis or card). |
path | string |
application/json application/xml
Response codes found in response codes.
returns ports
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns port
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port
application/json application/xml
port object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing port
application/json application/xml
port object that needs to be updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string | |
port-name |
A unique name for the port relative to the containing hardware. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
chassis-name |
A globally unique name for the chassis. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
chassis-name |
A globally unique name for the chassis. |
path | string |
application/json application/xml
Response codes found in response codes.
returns collections
collection-id |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
orchestration-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns collection
collection-id |
Collection Object UUID |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing collection
application/json application/xml
collection object that needs to be created or updated.
collection-id |
Collection Object UUID |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing collection
application/json application/xml
collection object that needs to be updated.
collection-id |
Collection Object UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing collection
application/json application/xml
collection-id |
Collection Object UUID |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
collection-id |
Collection Object UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
collection-id |
Collection Object UUID |
path | string |
application/json application/xml
Response codes found in response codes.
returns configurations
configuration-id |
n/a |
query | string | |
configuration-name |
n/a |
query | string | |
configuration-type |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
configuration-role |
n/a |
query | string | |
configuration-function |
n/a |
query | string | |
orchestration-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns configuration
configuration-id |
UUID assigned to configuration. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing configuration
application/json application/xml
configuration object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing configuration
application/json application/xml
configuration object that needs to be updated.
configuration-id |
UUID assigned to configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing configuration
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns evcs
configuration-id |
UUID assigned to configuration. |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns evc
configuration-id |
UUID assigned to configuration. |
path | string | |
evc-id |
Unique/key field for the evc object |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing evc
application/json application/xml
evc object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
evc-id |
Unique/key field for the evc object |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing evc
application/json application/xml
evc object that needs to be updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
evc-id |
Unique/key field for the evc object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing evc
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
evc-id |
Unique/key field for the evc object |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
evc-id |
Unique/key field for the evc object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
evc-id |
Unique/key field for the evc object |
path | string |
application/json application/xml
Response codes found in response codes.
returns forwarder-evcs
configuration-id |
UUID assigned to configuration. |
path | string | |
circuit-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns forwarder-evc
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing forwarder-evc
application/json application/xml
forwarder-evc object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing forwarder-evc
application/json application/xml
forwarder-evc object that needs to be updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing forwarder-evc
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlan-mappings
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan-mapping
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
vlan-mapping-id |
Key for vlan-mapping object. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan-mapping
application/json application/xml
vlan-mapping object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
vlan-mapping-id |
Key for vlan-mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vlan-mapping
application/json application/xml
vlan-mapping object that needs to be updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
vlan-mapping-id |
Key for vlan-mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan-mapping
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
vlan-mapping-id |
Key for vlan-mapping object. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
vlan-mapping-id |
Key for vlan-mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
forwarder-evc-id |
Key for forwarder-evc object |
path | string | |
vlan-mapping-id |
Key for vlan-mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
returns metadata
configuration-id |
UUID assigned to configuration. |
path | string | |
metaname |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
configuration-id |
UUID assigned to configuration. |
path | string | |
metaname | path | 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.
configuration-id |
UUID assigned to configuration. |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
update an existing metadatum
application/json application/xml
metadatum object that needs to be updated.
configuration-id |
UUID assigned to configuration. |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
configuration-id |
UUID assigned to configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
configuration-id |
UUID assigned to configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
returns connectivities
connectivity-id |
n/a |
query | string | |
bandwidth-profile-name |
n/a |
query | string | |
vpn-type |
n/a |
query | string | |
color-aware |
n/a |
query | string | |
coupling-flag |
n/a |
query | string | |
etht-svc-name |
n/a |
query | string | |
access-provider-id |
n/a |
query | string | |
access-client-id |
n/a |
query | string | |
access-topology-id |
n/a |
query | string | |
access-node-id |
n/a |
query | string | |
access-ltp-id |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns connectivity
connectivity-id |
Uniquely identifies this connectivity by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing connectivity
application/json application/xml
connectivity object that needs to be created or updated.
connectivity-id |
Uniquely identifies this connectivity by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing connectivity
application/json application/xml
connectivity object that needs to be updated.
connectivity-id |
Uniquely identifies this connectivity by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing connectivity
application/json application/xml
connectivity-id |
Uniquely identifies this connectivity by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
connectivity-id |
Uniquely identifies this connectivity by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
connectivity-id |
Uniquely identifies this connectivity by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns devices
device-id |
n/a |
query | string | |
esn |
n/a |
query | string | |
device-name |
n/a |
query | string | |
vendor |
n/a |
query | string | |
class |
n/a |
query | string | |
type |
n/a |
query | string | |
version |
n/a |
query | string | |
system-ip |
n/a |
query | string | |
system-ipv4 |
n/a |
query | string | |
system-ipv6 |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns device
device-id |
Uniquely identifies this device by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing device
application/json application/xml
device object that needs to be created or updated.
device-id |
Uniquely identifies this device by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing device
application/json application/xml
device object that needs to be updated.
device-id |
Uniquely identifies this device by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing device
application/json application/xml
device-id |
Uniquely identifies this device by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
device-id |
Uniquely identifies this device by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
device-id |
Uniquely identifies this device by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns ext-aai-networks
aai-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns ext-aai-network
aai-id |
Unique ID of the referenced AAI. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ext-aai-network
application/json application/xml
ext-aai-network object that needs to be created or updated.
aai-id |
Unique ID of the referenced AAI. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing ext-aai-network
application/json application/xml
ext-aai-network object that needs to be updated.
aai-id |
Unique ID of the referenced AAI. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing ext-aai-network
application/json application/xml
aai-id |
Unique ID of the referenced AAI. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns esr-system-info
aai-id |
Unique ID of the referenced AAI. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be created or updated.
aai-id |
Unique ID of the referenced AAI. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing esr-system-info
application/json application/xml
esr-system-info object that needs to be updated.
aai-id |
Unique ID of the referenced AAI. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing esr-system-info
application/json application/xml
aai-id |
Unique ID of the referenced AAI. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
aai-id |
Unique ID of the referenced AAI. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
aai-id |
Unique ID of the referenced AAI. |
path | string | |
esr-system-info-id |
Unique ID of esr system info. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
aai-id |
Unique ID of the referenced AAI. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
aai-id |
Unique ID of the referenced AAI. |
path | string |
application/json application/xml
Response codes found in response codes.
returns forwarding-paths
forwarding-path-id |
n/a |
query | string | |
forwarding-path-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns forwarding-path
forwarding-path-id |
Unique ID of this FP |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing forwarding-path
application/json application/xml
forwarding-path object that needs to be created or updated.
forwarding-path-id |
Unique ID of this FP |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing forwarding-path
application/json application/xml
forwarding-path object that needs to be updated.
forwarding-path-id |
Unique ID of this FP |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing forwarding-path
application/json application/xml
forwarding-path-id |
Unique ID of this FP |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns forwarders
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
n/a |
query | integer |
application/json application/xml
successful operation
Response codes found in response codes.
returns forwarder
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
Unique ID of this segmentation |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing forwarder
application/json application/xml
forwarder object that needs to be created or updated.
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
Unique ID of this segmentation |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing forwarder
application/json application/xml
forwarder object that needs to be updated.
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
Unique ID of this segmentation |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing forwarder
application/json application/xml
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
Unique ID of this segmentation |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
Unique ID of this segmentation |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
forwarding-path-id |
Unique ID of this FP |
path | string | |
sequence |
Unique ID of this segmentation |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
forwarding-path-id |
Unique ID of this FP |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
forwarding-path-id |
Unique ID of this FP |
path | string |
application/json application/xml
Response codes found in response codes.
returns fqdns
fqdn |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns fqdn
fqdn |
Fully qualified domain name. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing fqdn
application/json application/xml
fqdn object that needs to be created or updated.
fqdn |
Fully qualified domain name. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing fqdn
application/json application/xml
fqdn object that needs to be updated.
fqdn |
Fully qualified domain name. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing fqdn
application/json application/xml
fqdn |
Fully qualified domain name. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
fqdn |
Fully qualified domain name. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
fqdn |
Fully qualified domain name. |
path | string |
application/json application/xml
Response codes found in response codes.
returns generic-vnfs
vnf-id |
n/a |
query | string | |
vnf-name |
n/a |
query | string | |
vnf-name2 |
n/a |
query | string | |
vnf-type |
n/a |
query | string | |
service-id |
n/a |
query | string | |
regional-resource-zone |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string | |
is-closed-loop-disabled |
n/a |
query | boolean | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
widget-model-id |
n/a |
query | string | |
widget-model-version |
n/a |
query | string | |
nf-type |
n/a |
query | string | |
nf-function |
n/a |
query | string | |
nf-role |
n/a |
query | string | |
nf-naming-code |
n/a |
query | string | |
nm-profile-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns generic-vnf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
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.
update an existing generic-vnf
application/json application/xml
generic-vnf object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing generic-vnf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns bgp-groups
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-group
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-group
application/json application/xml
bgp-group object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-group
application/json application/xml
bgp-group object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-group
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
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 | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-group-id |
UUID. |
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 | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns bgp-neighbors
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-neighbor
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-neighbor
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
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 | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
bgp-neighbor-id |
UUID. |
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 | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns entitlements
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
n/a |
query | string | |
resource-uuid |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns entitlement
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing entitlement
application/json application/xml
entitlement object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing entitlement
application/json application/xml
entitlement object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing entitlement
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
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 | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
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 |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
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.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
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.
update an existing lag-interface
application/json application/xml
lag-interface object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | 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 | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be 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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.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 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 | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be 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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be 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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
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.
returns licenses
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
n/a |
query | string | |
resource-uuid |
n/a |
query | string | |
project-number |
n/a |
query | string | |
order-number |
n/a |
query | string | |
receipt-date |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns license
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing license
application/json application/xml
license object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing license
application/json application/xml
license object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing license
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
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 | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vf-modules
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
n/a |
query | string | |
vf-module-name |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
widget-model-id |
n/a |
query | string | |
widget-model-version |
n/a |
query | string | |
contrail-service-instance-fqdn |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vf-module
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
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.
update an existing vf-module
application/json application/xml
vf-module object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vf-module
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
vf-module-id |
Unique ID of vf-module. |
path | string |
application/json application/xml
Response codes found in response codes.
returns hw-components
hw-component-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns hw-component
hw-component-id |
UUID |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing hw-component
application/json application/xml
hw-component object that needs to be created or updated.
hw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing hw-component
application/json application/xml
hw-component object that needs to be updated.
hw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing hw-component
application/json application/xml
hw-component-id |
UUID |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
hw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
hw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
returns instance-groups
id |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns instance-group
id |
Instance Group ID, UUID assigned to this instance. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing instance-group
application/json application/xml
instance-group object that needs to be created or updated.
id |
Instance Group ID, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing instance-group
application/json application/xml
instance-group object that needs to be updated.
id |
Instance Group ID, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing instance-group
application/json application/xml
id |
Instance Group ID, UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
id |
Instance Group 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
id |
Instance Group ID, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns interlayer-attachments
id |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns interlayer-attachment
id |
Id that identifies the interlayer topology attachment |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing interlayer-attachment
application/json application/xml
interlayer-attachment object that needs to be created or updated.
id |
Id that identifies the interlayer topology attachment |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing interlayer-attachment
application/json application/xml
interlayer-attachment object that needs to be updated.
id |
Id that identifies the interlayer topology attachment |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing interlayer-attachment
application/json application/xml
id |
Id that identifies the interlayer topology attachment |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
id |
Id that identifies the interlayer topology attachment |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
id |
Id that identifies the interlayer topology attachment |
path | string |
application/json application/xml
Response codes found in response codes.
returns ipsec-configurations
ipsec-configuration-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns ipsec-configuration
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ipsec-configuration
application/json application/xml
ipsec-configuration object that needs to be created or updated.
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing ipsec-configuration
application/json application/xml
ipsec-configuration object that needs to be updated.
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing ipsec-configuration
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string |
application/json application/xml
Response codes found in response codes.
returns vig-servers
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vig-server
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vig-server
application/json application/xml
vig-server object that needs to be created or updated.
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vig-server
application/json application/xml
vig-server object that needs to be updated.
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vig-server
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ipsec-configuration-id |
UUID of this configuration |
path | string | |
vig-address-type |
indicates whether the VIG is for AVPN or INTERNET |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-networks
network-id |
n/a |
query | string | |
network-name |
n/a |
query | string | |
network-role |
n/a |
query | string | |
service-id |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string | |
contrail-network-fqdn |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
widget-model-id |
n/a |
query | string | |
widget-model-version |
n/a |
query | string | |
network-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l3-network
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
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.
update an existing l3-network
application/json application/xml
l3-network object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-network
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns aggregate-routes
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
agg-route-id |
n/a |
query | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns aggregate-route
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing aggregate-route
application/json application/xml
aggregate-route object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing aggregate-route
application/json application/xml
aggregate-route object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing aggregate-route
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
agg-route-id |
Route UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
agg-route-id |
Route 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 | |
agg-route-id |
Route UUID. |
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 | |
vlan-id-inner |
n/a |
query | integer |
application/json application/xml
successful operation
Response codes found in response codes.
returns ctag-assignment
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing ctag-assignment
application/json application/xml
ctag-assignment object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing ctag-assignment
application/json application/xml
ctag-assignment object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing ctag-assignment
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
vlan-id-inner |
id. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string |
application/json application/xml
Response codes found in response codes.
returns segmentation-assignments
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns segmentation-assignment
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
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.
update an existing segmentation-assignment
application/json application/xml
segmentation-assignment object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing segmentation-assignment
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
segmentation-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns subnets
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
n/a |
query | string | |
subnet-name |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
subnet-type |
n/a |
query | string | |
subnet-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns subnet
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
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.
update an existing subnet
application/json application/xml
subnet object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing subnet
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns bgp-neighbors
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-neighbor
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-neighbor
application/json application/xml
bgp-neighbor 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 | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-neighbor
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 | |
bgp-neighbor-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family 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 | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
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 | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family 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 | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
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 | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns host-routes
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns host-route
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing host-route
application/json application/xml
host-route 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 | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing host-route
application/json application/xml
host-route object that needs to be updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing host-route
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 | |
host-route-id |
host-route id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
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 | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Network ID, should be uuid. Unique across A&AI. |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns label-restrictions
id |
n/a |
query | string | |
label-start |
n/a |
query | integer | |
label-end |
n/a |
query | integer | |
range-bitmap |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns label-restriction
id |
Id that identifies the label restriction |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing label-restriction
application/json application/xml
label-restriction object that needs to be created or updated.
id |
Id that identifies the label restriction |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing label-restriction
application/json application/xml
label-restriction object that needs to be updated.
id |
Id that identifies the label restriction |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing label-restriction
application/json application/xml
id |
Id that identifies the label restriction |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
id |
Id that identifies the label restriction |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
id |
Id that identifies the label restriction |
path | string |
application/json application/xml
Response codes found in response codes.
returns lag-links
link-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-link
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-link
application/json application/xml
lag-link object that needs to be created or updated.
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing lag-link
application/json application/xml
lag-link object that needs to be updated.
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-link
application/json application/xml
link-name |
Alphabetical concatenation of lag-interface names |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
link-name |
Alphabetical concatenation of lag-interface names |
path | string |
application/json application/xml
Response codes found in response codes.
returns lan-port-configs
lan-port-config-id |
n/a |
query | string | |
lan-port-config-name |
n/a |
query | string | |
device-id |
n/a |
query | string | |
port-id |
n/a |
query | string | |
ipv4-address |
n/a |
query | string | |
ipv6-address |
n/a |
query | string | |
vlan-tag |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lan-port-config
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lan-port-config
application/json application/xml
lan-port-config object that needs to be created or updated.
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing lan-port-config
application/json application/xml
lan-port-config object that needs to be updated.
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lan-port-config
application/json application/xml
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns dhcp-services
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
n/a |
query | string | |
server-ipv4-address |
n/a |
query | string | |
server-ipv6-address |
n/a |
query | string | |
dhcp-service-type |
n/a |
query | string | |
domain-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns dhcp-service
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
Uniquely identifies this dhcp-service by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing dhcp-service
application/json application/xml
dhcp-service object that needs to be created or updated.
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
Uniquely identifies this dhcp-service by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing dhcp-service
application/json application/xml
dhcp-service object that needs to be updated.
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
Uniquely identifies this dhcp-service by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing dhcp-service
application/json application/xml
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
Uniquely identifies this dhcp-service by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
Uniquely identifies this dhcp-service by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string | |
dhcp-service-id |
Uniquely identifies this dhcp-service by id |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
lan-port-config-id |
Uniquely identifies this lan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns logical-links
link-name |
n/a |
query | string | |
link-type |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
widget-model-id |
n/a |
query | string | |
widget-model-version |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
link-id |
n/a |
query | string | |
circuit-id |
n/a |
query | string | |
purpose |
n/a |
query | string | |
link-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns logical-link
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
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.
update an existing logical-link
application/json application/xml
logical-link object that needs to be updated.
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing logical-link
application/json application/xml
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
link-name |
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
returns mappings
mapping-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns mapping
mapping-id |
Key for mapping object. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing mapping
application/json application/xml
mapping object that needs to be created or updated.
mapping-id |
Key for mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing mapping
application/json application/xml
mapping object that needs to be updated.
mapping-id |
Key for mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing mapping
application/json application/xml
mapping-id |
Key for mapping object. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
mapping-id |
Key for mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
mapping-id |
Key for mapping object. |
path | string |
application/json application/xml
Response codes found in response codes.
returns multicast-configurations
multicast-configuration-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns multicast-configuration
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing multicast-configuration
application/json application/xml
multicast-configuration object that needs to be created or updated.
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing multicast-configuration
application/json application/xml
multicast-configuration object that needs to be updated.
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing multicast-configuration
application/json application/xml
multicast-configuration-id |
Unique id of multicast configuration. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
multicast-configuration-id |
Unique id of multicast configuration. |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-policies
network-policy-id |
n/a |
query | string | |
network-policy-fqdn |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns network-policy
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-policy
application/json application/xml
network-policy object that needs to be created or updated.
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing network-policy
application/json application/xml
network-policy object that needs to be updated.
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-policy
application/json application/xml
network-policy-id |
UUID representing unique key to this instance |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-policy-id |
UUID representing unique key to this instance |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-ranges
network-range-id |
n/a |
query | string | |
network-range-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns network-range
network-range-id |
UUID |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-range
application/json application/xml
network-range object that needs to be created or updated.
network-range-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing network-range
application/json application/xml
network-range object that needs to be updated.
network-range-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-range
application/json application/xml
network-range-id |
UUID |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
network-range-id |
UUID |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity object that needs to be created or updated.
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be updated.
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
application/json application/xml
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state object that needs to be created or updated.
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be updated.
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
application/json application/xml
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-range-id |
UUID |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-range-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-range-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-resources
network-id |
n/a |
query | string | |
provider-id |
n/a |
query | string | |
client-id |
n/a |
query | string | |
te-topo-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns network-resource
network-id |
Uniquely identifies this network-resource by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-resource
application/json application/xml
network-resource object that needs to be created or updated.
network-id |
Uniquely identifies this network-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing network-resource
application/json application/xml
network-resource object that needs to be updated.
network-id |
Uniquely identifies this network-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-resource
application/json application/xml
network-id |
Uniquely identifies this network-resource by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
network-id |
Uniquely identifies this network-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
network-id |
Uniquely identifies this network-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns network-routes
route-id |
n/a |
query | string | |
type |
n/a |
query | string | |
role |
n/a |
query | string | |
function |
n/a |
query | string | |
ip-address |
n/a |
query | string | |
prefix-length |
n/a |
query | integer | |
next-hop |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns network-route
route-id |
unique identifier example uuid. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing network-route
application/json application/xml
network-route object that needs to be created or updated.
route-id |
unique identifier example uuid. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing network-route
application/json application/xml
network-route object that needs to be updated.
route-id |
unique identifier example uuid. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing network-route
application/json application/xml
route-id |
unique identifier example uuid. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
route-id |
unique identifier example uuid. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
route-id |
unique identifier example uuid. |
path | string |
application/json application/xml
Response codes found in response codes.
returns newvces
vnf-id2 |
n/a |
query | string | |
vnf-name |
n/a |
query | string | |
vnf-name2 |
n/a |
query | string | |
vnf-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns newvce
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing newvce
application/json application/xml
newvce object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing newvce
application/json application/xml
newvce object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing newvce
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id2 |
Unique id of VNF, can't use same attribute name right now until we promote this new object |
path | string |
application/json application/xml
Response codes found in response codes.
returns next-hops
next-hop-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns next-hop
next-hop-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing next-hop
application/json application/xml
next-hop object that needs to be created or updated.
next-hop-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing next-hop
application/json application/xml
next-hop object that needs to be updated.
next-hop-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing next-hop
application/json application/xml
next-hop-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
next-hop-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
next-hop-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns physical-links
link-name |
n/a |
query | string | |
circuit-id |
n/a |
query | string | |
link-function |
n/a |
query | string | |
link-role |
n/a |
query | string | |
link-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns physical-link
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
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.
update an existing physical-link
application/json application/xml
physical-link object that needs to be updated.
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing physical-link
application/json application/xml
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
link-name |
e.g., hostnameA_p-connection_nameA_hostnameZ+p_connection-nameZ |
path | string |
application/json application/xml
Response codes found in response codes.
returns pnfs
pnf-name |
n/a |
query | string | |
nf-naming-code |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
inv-status |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
nf-role |
n/a |
query | string | |
admin-status |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string | |
nf-type |
n/a |
query | string | |
equipment-clli |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns pnf
pnf-name |
unique name of Physical Network Function. |
path | string | |
software-version-id |
n/a |
query | string | |
is-active-sw-ver |
n/a |
query | boolean |
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.
update an existing pnf
application/json application/xml
pnf object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing pnf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
pnf-name |
unique name of Physical Network Function. |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
returns bgp-groups
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-group
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-group
application/json application/xml
bgp-group object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-group
application/json application/xml
bgp-group object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-group
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
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 | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-group-id |
UUID. |
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 | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns bgp-neighbors
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-neighbor
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-neighbor
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
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 | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
bgp-neighbor-id |
UUID. |
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 | |
bgp-neighbor-id |
UUID. |
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 |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | 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 given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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
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 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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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
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 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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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 given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name 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 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
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
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.
update an existing lag-interface
application/json application/xml
lag-interface object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | 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 | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 | |
l-interface.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 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 | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string | |
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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns p-interfaces
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
n/a |
query | string | |
interface-name2 |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
network-ref |
n/a |
query | string | |
operational-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns p-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
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.
update an existing p-interface
application/json application/xml
p-interface object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing p-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state 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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
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 | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
returns bandwidth-attributes
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bandwidth-attribute
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bandwidth-attribute
application/json application/xml
bandwidth-attribute 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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bandwidth-attribute
application/json application/xml
bandwidth-attribute object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bandwidth-attribute
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns available-bandwidth-map
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns available-bandwidth
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing available-bandwidth
application/json application/xml
available-bandwidth 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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing available-bandwidth
application/json application/xml
available-bandwidth object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing available-bandwidth
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
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 | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
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 | |
bwa-id |
Id that identifies the bandwidth attribute |
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 | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | 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 | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | 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 | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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
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 | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 | |
l-interface.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 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 | |
l3-interface-ipv4-address |
IP address |
path | 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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
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 | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
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 | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string |
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.
returns sriov-pfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-pf
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-pf
application/json application/xml
sriov-pf 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 | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-pf
application/json application/xml
sriov-pf object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-pf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
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 | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
Response codes found in response codes.
returns software-versions
pnf-name |
unique name of Physical Network Function. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns software-version
pnf-name |
unique name of Physical Network Function. |
path | string | |
software-version-id |
Identifier of the software version |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing software-version
application/json application/xml
software-version object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
software-version-id |
Identifier of the software version |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing software-version
application/json application/xml
software-version object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
software-version-id |
Identifier of the software version |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing software-version
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
software-version-id |
Identifier of the software version |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns vrfs
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
n/a |
query | string | |
vrf-role |
n/a |
query | string | |
vrf-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vrf
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vrf
application/json application/xml
vrf object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vrf
application/json application/xml
vrf object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vrf
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns aggregate-routes
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
n/a |
query | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns aggregate-route
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing aggregate-route
application/json application/xml
aggregate-route object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing aggregate-route
application/json application/xml
aggregate-route object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing aggregate-route
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
Route UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
Route UUID. |
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 | |
vrf-id |
VRF UUID. |
path | string | |
agg-route-id |
Route UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns bgp-groups
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-group
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-group
application/json application/xml
bgp-group object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-group
application/json application/xml
bgp-group object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-group
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
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 | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
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 | |
vrf-id |
VRF UUID. |
path | string | |
bgp-group-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns bgp-neighbors
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-neighbor
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-neighbor
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
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 | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
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 | |
vrf-id |
VRF UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
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 | |
vrf-id |
VRF UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns route-targets
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns route-target
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing route-target
application/json application/xml
route-target object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing route-target
application/json application/xml
route-target object that needs to be updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing route-target
application/json application/xml
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
pnf-name |
unique name of Physical Network Function. |
path | string | |
vrf-id |
VRF UUID. |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
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 | |
vrf-id |
VRF UUID. |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
returns route-table-references
route-table-reference-id |
n/a |
query | string | |
route-table-reference-fqdn |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns route-table-reference
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing route-table-reference
application/json application/xml
route-table-reference object that needs to be created or updated.
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing route-table-reference
application/json application/xml
route-table-reference object that needs to be updated.
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing route-table-reference
application/json application/xml
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
route-table-reference-id |
Route Table Reference id, UUID assigned to this instance. |
path | string |
application/json application/xml
Response codes found in response codes.
returns sdwan-vpns
sdwan-vpn-id |
n/a |
query | string | |
sdwan-vpn-name |
n/a |
query | string | |
vxlan-id |
n/a |
query | string | |
topology |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sdwan-vpn
sdwan-vpn-id |
Uniquely identifies this sdwan-vpn by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sdwan-vpn
application/json application/xml
sdwan-vpn object that needs to be created or updated.
sdwan-vpn-id |
Uniquely identifies this sdwan-vpn by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sdwan-vpn
application/json application/xml
sdwan-vpn object that needs to be updated.
sdwan-vpn-id |
Uniquely identifies this sdwan-vpn by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sdwan-vpn
application/json application/xml
sdwan-vpn-id |
Uniquely identifies this sdwan-vpn by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
sdwan-vpn-id |
Uniquely identifies this sdwan-vpn by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
sdwan-vpn-id |
Uniquely identifies this sdwan-vpn by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns site-pair-sets
site-pair-set-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns site-pair-set
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing site-pair-set
application/json application/xml
site-pair-set object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing site-pair-set
application/json application/xml
site-pair-set object that needs to be updated.
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing site-pair-set
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string |
application/json application/xml
Response codes found in response codes.
returns routing-instances
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns routing-instance
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing routing-instance
application/json application/xml
routing-instance object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing routing-instance
application/json application/xml
routing-instance object that needs to be updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing routing-instance
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string |
application/json application/xml
Response codes found in response codes.
returns site-pairs
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns site-pair
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing site-pair
application/json application/xml
site-pair object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing site-pair
application/json application/xml
site-pair object that needs to be updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing site-pair
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns classes-of-service
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns class-of-service
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing class-of-service
application/json application/xml
class-of-service object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing class-of-service
application/json application/xml
class-of-service object that needs to be updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing class-of-service
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string | |
cos |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-pair-set-id |
Unique id of site pair set. |
path | string | |
routing-instance-id |
Unique id of routing instance |
path | string | |
site-pair-id |
unique identifier of probe |
path | string |
application/json application/xml
Response codes found in response codes.
returns site-resources
site-resource-id |
n/a |
query | string | |
site-resource-name |
n/a |
query | string | |
type |
n/a |
query | string | |
role |
n/a |
query | string | |
generated-site-id |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns site-resource
site-resource-id |
Uniquely identifies this site-resource by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing site-resource
application/json application/xml
site-resource object that needs to be created or updated.
site-resource-id |
Uniquely identifies this site-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing site-resource
application/json application/xml
site-resource object that needs to be updated.
site-resource-id |
Uniquely identifies this site-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing site-resource
application/json application/xml
site-resource-id |
Uniquely identifies this site-resource by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
site-resource-id |
Uniquely identifies this site-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
site-resource-id |
Uniquely identifies this site-resource by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns sw-components
sw-component-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sw-component
sw-component-id |
UUID |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sw-component
application/json application/xml
sw-component object that needs to be created or updated.
sw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sw-component
application/json application/xml
sw-component object that needs to be updated.
sw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sw-component
application/json application/xml
sw-component-id |
UUID |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
sw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
sw-component-id |
UUID |
path | string |
application/json application/xml
Response codes found in response codes.
returns te-link-attributes
id |
n/a |
query | string | |
link-protection-type |
n/a |
query | string | |
access-type |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns te-link-attribute
id |
Id that identifies the TE link attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing te-link-attribute
application/json application/xml
te-link-attribute object that needs to be created or updated.
id |
Id that identifies the TE link attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing te-link-attribute
application/json application/xml
te-link-attribute object that needs to be updated.
id |
Id that identifies the TE link attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing te-link-attribute
application/json application/xml
id |
Id that identifies the TE link attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
id |
Id that identifies the TE link attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
id |
Id that identifies the TE link attribute |
path | string |
application/json application/xml
Response codes found in response codes.
returns tunnel-termination-points
ttp-id |
n/a |
query | string | |
tunnel-tp-id |
n/a |
query | string | |
name |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns tunnel-termination-point
ttp-id |
Id that identifies the tunnel termination point |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing tunnel-termination-point
application/json application/xml
tunnel-termination-point object that needs to be created or updated.
ttp-id |
Id that identifies the tunnel termination point |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing tunnel-termination-point
application/json application/xml
tunnel-termination-point object that needs to be updated.
ttp-id |
Id that identifies the tunnel termination point |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing tunnel-termination-point
application/json application/xml
ttp-id |
Id that identifies the tunnel termination point |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
ttp-id |
Id that identifies the tunnel termination point |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
ttp-id |
Id that identifies the tunnel termination point |
path | string |
application/json application/xml
Response codes found in response codes.
returns unis
id |
n/a |
query | string | |
tp-id |
n/a |
query | string | |
cvlan |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns uni
id |
Id that identifies the UNI |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing uni
application/json application/xml
uni object that needs to be created or updated.
id |
Id that identifies the UNI |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing uni
application/json application/xml
uni object that needs to be updated.
id |
Id that identifies the UNI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing uni
application/json application/xml
id |
Id that identifies the UNI |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
id |
Id that identifies the UNI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
id |
Id that identifies the UNI |
path | string |
application/json application/xml
Response codes found in response codes.
returns vces
vnf-id |
n/a |
query | string | |
vnf-name |
n/a |
query | string | |
vnf-name2 |
n/a |
query | string | |
vnf-type |
n/a |
query | string | |
service-id |
n/a |
query | string | |
regional-resource-zone |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string | |
vpe-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vce
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vce
application/json application/xml
vce object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vce
application/json application/xml
vce object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vce
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns entitlements
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
n/a |
query | string | |
resource-uuid |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns entitlement
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing entitlement
application/json application/xml
entitlement object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing entitlement
application/json application/xml
entitlement object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing entitlement
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
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 | |
group-uuid |
Unique ID for the entitlement group the resource comes from, should be uuid. |
path | string | |
resource-uuid |
Unique ID of an entitlement resource. |
path | string |
application/json application/xml
Response codes found in response codes.
returns licenses
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
n/a |
query | string | |
resource-uuid |
n/a |
query | string | |
project-number |
n/a |
query | string | |
order-number |
n/a |
query | string | |
receipt-date |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns license
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing license
application/json application/xml
license object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing license
application/json application/xml
license object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing license
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
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 | |
group-uuid |
Unique ID for the license group the resource belongs to, should be uuid. |
path | string | |
resource-uuid |
Unique ID of a license resource. |
path | string |
application/json application/xml
Response codes found in response codes.
returns port-groups
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
port-group-id |
n/a |
query | string | |
switch-name |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
heat-stack-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns port-group
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing port-group
application/json application/xml
port-group object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing port-group
application/json application/xml
port-group object that needs to be updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing port-group
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string | |
interface-id |
Unique ID of the interface |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-id |
Unique id of VNF. This is unique across the graph. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vnfcs
vnfc-name |
n/a |
query | string | |
nfc-naming-code |
n/a |
query | string | |
nfc-function |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
ipaddress-v4-oam-vip |
n/a |
query | string | |
is-closed-loop-disabled |
n/a |
query | boolean | |
group-notation |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vnfc
vnfc-name |
Unique ID of vnfc. |
path | 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.
update an existing vnfc
application/json application/xml
vnfc object that needs to be updated.
vnfc-name |
Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vnfc
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns cps
vnfc-name |
Unique ID of vnfc. |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns cp
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing cp
application/json application/xml
cp object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing cp
application/json application/xml
cp object that needs to be updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing cp
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
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
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
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
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
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
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
cp-instance-id |
Unique ID of the connection point. |
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 | |
cp-instance-id |
Unique ID of the connection point. |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | 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.
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
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
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | 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.
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
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
vnfc-name |
Unique ID of vnfc. |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnfc-name |
Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnfc-name |
Unique ID of vnfc. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vpls-pes
equipment-name |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vpls-pe
equipment-name | path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vpls-pe
application/json application/xml
vpls-pe object that needs to be created or updated.
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
update an existing vpls-pe
application/json application/xml
vpls-pe object that needs to be updated.
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vpls-pe
application/json application/xml
equipment-name | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns lag-interfaces
equipment-name | path | string | ||
interface-name |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns lag-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing lag-interface
application/json application/xml
lag-interface object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing lag-interface
application/json application/xml
lag-interface object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing lag-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l-interface.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 l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the link aggregate interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns p-interfaces
equipment-name | path | string | ||
interface-name |
n/a |
query | string | |
interface-name2 |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
network-ref |
n/a |
query | string | |
operational-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns p-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing p-interface
application/json application/xml
p-interface object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing p-interface
application/json application/xml
p-interface object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing p-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activities
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity
application/json application/xml
activity object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing activity
application/json application/xml
activity object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing activity
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns activity-states
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns activity-state
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing activity-state
application/json application/xml
activity-state object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
update an existing activity-state
application/json application/xml
activity-state object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing activity-state
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string | |
state-order |
Order for the activity state. |
path | integer |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
activity-id |
Unique id for the activity. (UUID) |
path | string |
application/json application/xml
Response codes found in response codes.
returns bandwidth-attributes
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bandwidth-attribute
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bandwidth-attribute
application/json application/xml
bandwidth-attribute object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bandwidth-attribute
application/json application/xml
bandwidth-attribute object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bandwidth-attribute
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns available-bandwidth-map
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns available-bandwidth
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing available-bandwidth
application/json application/xml
available-bandwidth object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing available-bandwidth
application/json application/xml
available-bandwidth object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing available-bandwidth
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string | |
ab-id |
Id that identifies the attribute |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
bwa-id |
Id that identifies the bandwidth attribute |
path | string |
application/json application/xml
Response codes found in response codes.
returns l-interfaces
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
interface-name |
n/a |
query | string | |
interface-role |
n/a |
query | string | |
interface-id |
n/a |
query | string | |
macaddr |
n/a |
query | string | |
network-name |
n/a |
query | string | |
interface-type |
n/a |
query | string | |
prov-status |
n/a |
query | string | |
interface-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns l-interface
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l-interface
application/json application/xml
l-interface object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l-interface
application/json application/xml
l-interface object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l-interface
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-vfs
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
n/a |
query | string | |
vf-vlan-filter |
n/a |
query | string | |
vf-mac-filter |
n/a |
query | string | |
vf-vlan-strip |
n/a |
query | boolean | |
neutron-network-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-vf
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-vf
application/json application/xml
sriov-vf object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-vf
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
pci-id |
PCI ID used to identify the sriov-vf |
path | string |
application/json application/xml
Response codes found in response codes.
returns vlans
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
n/a |
query | string | |
vlan-id-inner |
n/a |
query | integer | |
vpn-key |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
prov-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vlan
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vlan
application/json application/xml
vlan object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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.
update an existing vlan
application/json application/xml
vlan object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vlan
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.interface-name |
Name given to the interface |
path | string | |
vlan-interface |
String that identifies the interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l-interface.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 l3-interface-ipv4-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv4-address-list
application/json application/xml
l3-interface-ipv4-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv4-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv4-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
returns l3-interface-ipv6-address-list
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing l3-interface-ipv6-address-list
application/json application/xml
l3-interface-ipv6-address-list object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing l3-interface-ipv6-address-list
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
l3-interface-ipv6-address |
IP address |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string |
application/json application/xml
Response codes found in response codes.
returns sriov-pfs
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns sriov-pf
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing sriov-pf
application/json application/xml
sriov-pf object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing sriov-pf
application/json application/xml
sriov-pf object that needs to be updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing sriov-pf
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string | ||
interface-name |
Name that identifies the physical interface |
path | string | |
pf-pci-id |
Identifier for the sriov-pf |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
equipment-name | path | string |
application/json application/xml
Response codes found in response codes.
returns vpn-bindings
vpn-id |
n/a |
query | string | |
vpn-name |
n/a |
query | string | |
vpn-type |
n/a |
query | string | |
access-provider-id |
n/a |
query | string | |
access-client-id |
n/a |
query | string | |
access-topology-id |
n/a |
query | string | |
src-access-node-id |
n/a |
query | string | |
src-access-ltp-id |
n/a |
query | string | |
dst-access-node-id |
n/a |
query | string | |
dst-access-ltp-id |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vpn-binding
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vpn-binding
application/json application/xml
vpn-binding object that needs to be created or updated.
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vpn-binding
application/json application/xml
vpn-binding object that needs to be updated.
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vpn-binding
application/json application/xml
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vpn-id |
VPN ID, globally unique within A&AI |
path | string |
application/json application/xml
Response codes found in response codes.
returns route-targets
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
data-owner |
n/a |
query | string | |
data-source |
n/a |
query | string | |
data-source-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns route-target
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing route-target
application/json application/xml
route-target object that needs to be created or updated.
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing route-target
application/json application/xml
route-target object that needs to be updated.
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing route-target
application/json application/xml
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vpn-id |
VPN ID, globally unique within A&AI |
path | string | |
global-route-target |
Number used to identify an RT, globally unique in the network |
path | string | |
route-target-role |
Role assigned to this route target |
path | string |
application/json application/xml
Response codes found in response codes.
returns wan-port-configs
wan-port-config-id |
n/a |
query | string | |
wan-port-config-name |
n/a |
query | string | |
device-id |
n/a |
query | string | |
ip-address |
n/a |
query | string | |
ipv4-address |
n/a |
query | string | |
ipv6-address |
n/a |
query | string | |
port-type |
n/a |
query | string | |
port-number |
n/a |
query | string | |
device-port-id |
n/a |
query | string | |
wan-port-id |
n/a |
query | string | |
operational-status |
n/a |
query | string | |
model-invariant-id |
n/a |
query | string | |
model-version-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns wan-port-config
wan-port-config-id |
Uniquely identifies this wan-port-config by id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing wan-port-config
application/json application/xml
wan-port-config object that needs to be created or updated.
wan-port-config-id |
Uniquely identifies this wan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing wan-port-config
application/json application/xml
wan-port-config object that needs to be updated.
wan-port-config-id |
Uniquely identifies this wan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing wan-port-config
application/json application/xml
wan-port-config-id |
Uniquely identifies this wan-port-config by id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
wan-port-config-id |
Uniquely identifies this wan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
wan-port-config-id |
Uniquely identifies this wan-port-config by id |
path | string |
application/json application/xml
Response codes found in response codes.
returns zones
zone-id |
n/a |
query | string | |
design-type |
n/a |
query | string | |
zone-context |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns zone
zone-id |
Code assigned by AIC to the zone |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing zone
application/json application/xml
zone object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing zone
application/json application/xml
zone object that needs to be updated.
zone-id |
Code assigned by AIC to the zone |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing zone
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string |
application/json application/xml
Response codes found in response codes.
returns subnets
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
n/a |
query | string | |
subnet-name |
n/a |
query | string | |
orchestration-status |
n/a |
query | string | |
subnet-type |
n/a |
query | string | |
subnet-function |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns subnet
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | 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.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing subnet
application/json application/xml
subnet object that needs to be updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing subnet
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
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 bgp-neighbors
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns bgp-neighbor
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing bgp-neighbor
application/json application/xml
bgp-neighbor object that needs to be updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing bgp-neighbor
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns address-families
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
n/a |
query | string | |
af-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns address-family
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing address-family
application/json application/xml
address-family object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing address-family
application/json application/xml
address-family object that needs to be updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing address-family
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string | |
address-family-id |
address family UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
bgp-neighbor-id |
UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns host-routes
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns host-route
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing host-route
application/json application/xml
host-route object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing host-route
application/json application/xml
host-route object that needs to be updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing host-route
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string | |
host-route-id |
host-route id |
path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
zone-id |
Code assigned by AIC to the zone |
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
zone-id |
Code assigned by AIC to the zone |
path | string | |
subnet-id |
Subnet ID, should be UUID. |
path | string |
application/json application/xml
Response codes found in response codes.
returns models
model-invariant-id |
n/a |
query | string | |
model-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns model
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | 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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing model
application/json application/xml
model object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition 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-vers
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
n/a |
query | string | |
model-name |
n/a |
query | string | |
model-version |
n/a |
query | string | |
distribution-status |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns model-ver
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing model-ver
application/json application/xml
model-ver object that needs to be created or updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
update an existing model-ver
application/json application/xml
model-ver object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model-ver
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns metadata
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns metadatum
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname | path | 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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
update an existing metadatum
application/json application/xml
metadatum object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing metadatum
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
metaname | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns model-elements
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns model-element
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | 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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
update an existing model-element
application/json application/xml
model-element object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model-element
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns model-constraints
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns model-constraint
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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
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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
update an existing model-constraint
application/json application/xml
model-constraint object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing model-constraint
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns constrained-element-sets
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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 |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns constrained-element-set
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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
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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
update an existing constrained-element-set
application/json application/xml
constrained-element-set object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing constrained-element-set
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns element-choice-sets
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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 |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns element-choice-set
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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
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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
update an existing element-choice-set
application/json application/xml
element-choice-set object that needs to be updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing element-choice-set
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string | ||
element-choice-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string | ||
model-constraint-uuid | path | string | ||
constrained-element-set-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string | |
model-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-version-id |
Unique identifier corresponding to one version of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string | |
model-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.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
model-invariant-id |
Unique identifier corresponding to the main definition of a model in ASDC |
path | string |
application/json application/xml
Response codes found in response codes.
returns named-queries
named-query-uuid |
n/a |
query | string | |
named-query-name |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns named-query
named-query-uuid | path | 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.
update an existing named-query
application/json application/xml
named-query object that needs to be updated.
named-query-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing named-query
application/json application/xml
named-query-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns named-query-elements
named-query-uuid | path | string | ||
named-query-element-uuid |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns named-query-element
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
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.
update an existing named-query-element
application/json application/xml
named-query-element object that needs to be updated.
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing named-query-element
application/json application/xml
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
returns property-constraints
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns property-constraint
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid | path | string |
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.
update an existing property-constraint
application/json application/xml
property-constraint object that needs to be updated.
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing property-constraint
application/json application/xml
named-query-uuid | path | string | ||
named-query-element-uuid | path | string | ||
property-constraint-uuid | path | string | ||
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
named-query-uuid | path | string | ||
named-query-element-uuid | path | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
named-query-uuid | path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
named-query-uuid | path | string |
application/json application/xml
Response codes found in response codes.
returns service-capabilities
service-type |
n/a |
query | string | |
vnf-type |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service-capability
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing service-capability
application/json application/xml
service-capability object that needs to be created or updated.
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing service-capability
application/json application/xml
service-capability object that needs to be updated.
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service-capability
application/json application/xml
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
service-type |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
vnf-type |
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures. |
path | string |
application/json application/xml
Response codes found in response codes.
returns services
service-id |
n/a |
query | string | |
service-description |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns service
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
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.
update an existing service
application/json application/xml
service object that needs to be updated.
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing service
application/json application/xml
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
service-id |
This gets defined by others to provide a unique ID for the service, we accept what is sent. |
path | string |
application/json application/xml
Response codes found in response codes.
returns vnf-images
vnf-image-uuid |
n/a |
query | string | |
application |
n/a |
query | string | |
application-vendor |
n/a |
query | string | |
application-version |
n/a |
query | string |
application/json application/xml
successful operation
Response codes found in response codes.
returns vnf-image
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
successful operation
Response codes found in response codes.
create or update an existing vnf-image
application/json application/xml
vnf-image object that needs to be created or updated.
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
update an existing vnf-image
application/json application/xml
vnf-image object that needs to be updated.
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing vnf-image
application/json application/xml
vnf-image-uuid |
Unique ID of this asset |
path | string | |
resource-version |
resource-version for concurrency |
query | string |
application/json application/xml
Response codes found in response codes.
see node definition for valid relationships
application/json application/xml
relationship object that needs to be created or updated.
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
delete an existing relationship
application/json application/xml
vnf-image-uuid |
Unique ID of this asset |
path | string |
application/json application/xml
Response codes found in response codes.
Collection of activities.
describes an activities
The activity applies to a cloud-region.(4)
The reservation information associated with a NAT Pool mapping.
An activity is being performed on a network-range.(4)
The activity applies to a p-interface.(4)
The activity applies to a pnf.(4)
The activity applies to a pserver.(4)
An activity-state is tracks the state of an activity.(1)
Unique id for the activity. (UUID)
Type of activity (ex, provisioning).
Name of the activity.
Application that created the activity.
Description of activity.
Date and Time activity is created.
Current state of the activity.
State reflected by the database.
Role
Function
Date/time last updated
Date/time expires
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
describes an activities
An activity-state is tracks the state of an activity.(4)
Order for the activity state.
Name of the activity state (ex, NVT-PROV).
View of the activity state.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of activity-states
Definition of address family
Address Family belongs to a bgp-group(4)
Address Family belongs to a bgp-neighbor(4)
A policy applies to an address family.
address family UUID.
address family type (aka afi)
address family subtype (aka safi)
role of address-family
function of address-family
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Aggregate route configs are used on the D2 IPEs for the Voice services. In 1902, SDNC will create aggregate-route objects and write them to A&AI.
An aggregate-route BelongsTo a vrf.(4)
A vpn-binding uses many aggregate routes
Route UUID.
Name of the forwarding-path
CIDR-mask for aggregate route subnet
Identifies is aggregate route is ipv4 or ipv6
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of aggregate routes.
Represents a slice or partial piece of a resource that gets separately allotted
AAI-1925
AAI-1925 For CCVPN Usecase
AAI-1925
For CCVPN Usecase
Allotted Resource id UUID assigned to this instance.
The descriptive information assigned to this allotted resource instance
Link back to more information in the controller
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Concurrency value
Orchestration status
Indicator for whether the resource is considered operational
Generic description of the type of allotted resource.
role in the network that this resource will be providing.
Store the name of this allotted-resource.
Store the id of the access provider of this allotted-resource.
Store the id of the access client of this allotted-resource.
Store the id of the access topology of this allotted-resource.
Store the id of the access node of this allotted-resource.
Store the id of the access ltp of this allotted-resource.
Store the cvlan of this allotted-resource.
Store the vpn-name of this allotted-resource.
This object is used to store slices of services being offered
Description of Autonomous System
A local autonomous-system is located in a zone.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor is a member of an autonomous-system.
pnf is located in the autonomous-system.
UUID
asn in the range of 0 to 9223372036854775807
type (global vs. local).
geographic region
role of autonomous system
Concurrency value
Collection of Autonomous Systems
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
Instance of an available-bandwidth-map
For MDONS usecase(4)
Id that identifies the attribute
ODU Type that identifies the ODU Eg. ODU0, ODU1, ODU2, ODU3, ODU4
The value of available bandwidth. Applicable only for ENNI.
Store the link to get more information for this object.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of Available Bandwidth. Added for ENNI in MDONS use case.
Instance of a bandwidth-attribute
For MDONS usecase(4)
For MDONS usecase(1)
Id that identifies the bandwidth attribute
Store the link to get more information for this object.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of bandwidth attribute. Added for ENNI in MDONS use case.
BFD (Bidirectional Forwarding Detection) is a protocol for detecting link failures.The BFD object is for persisting attributes for the links that have BFD enabled.
Unique identifier.
Used to categorize this object in conjunction with role & function. The most generic category.
Used to categorize this object in conjunction with type & function.
Used to categorize this object in conjunction with type & role. The most specific category.
bfd keep-alive parameter
bfd timeout parameter
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of bgp-group
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
A bgp-group belongs to a pnf.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
A bgp-group belongs to a pnf.(4)
Address Family belongs to a bgp-group(1)
bgp-neighbor is a member of an bgp-group.
The bgp-group associated to a generic-vnf.(3)
A policy applies to a bgp-group.
UUID.
name of bgp-group
type of bgp-group
role of bgp-group
function of bgp-group
local a-s number type of vrf (bridge-domain as an example)
local address
peer a-s number
peer address
description of bgp-group
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of bgp-neighbor
bgp-neighbor is a member of an autonomous-system.
bgp-neighbor is a member of an bgp-group.
bgp-neighbor uses To node-type.
bgp-neighbor uses To node-type.
A policy applies to a bgp-neighbor.
A bgp-neighbor belongs to a pnf.(4)
bgp-neighbor belongs To a subnet.(4)
bgp-neighbor uses To node-type.
bgp-neighbor uses To node-type.
A bgp-neighbor belongs to a vrf.(4)
Address Family belongs to a bgp-neighbor(1)
The configuration Uses bgp-neighbor.
The bgp-neighbor associated to a generic-vnf.(3)
A policy applies to a bgp-neighbor.
UUID.
name of bgp-group
type of bgp-group
role of bgp-group
local a-s number type of vrf (bridge-domain as an example)
local address
peer a-s number
peer address
description of bgp-group
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
provisioning status. Valid values can be found at (https://wiki.web.att.com/display/SPTIIRP/prov-status).
hostname of the peer
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Namespace for business related constructs
Definition of cable
A cable is located in a complex.(4)
The cable is this item from the hardware-catalog.
A cable is composed of one or more physical-links.
A pluggable that is intergrated with a cable.(1)
A channel-interface terminates a channel-link.
A unique name for the channel-link relative to the physical-link.
The type of cable.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of card
A card is located in a card-slot.(4)
The card is described by the hardware-catalog-item.
A pluggable slot is located in a card.(1)
A port is located in a card.(1)
The profile (set of characteristics) applies to the card.
The type of card.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of card-slot
A card-slot is located in a chassis.(4)
A card is located in a card-slot.(1)
The name of the card-slot (unique relative to the chassis).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of chassis
A chassis LinksTo a complex.
The chassis is described by the hardware-catalog-item.
A chassis is part of a pnf.
A chassis is part of a pserver.
A chassis is LocatedIn a rack.
A chassis uses space in a rack (aka one or more rack-units).
A card-slot is located in a chassis.(1)
A license belongs to a chassis.(1)
A pluggable-slot is located in a chassis.(1)
A port is LocatedIn a chassis.(1)
The profile (set of characteristics) applies to the chassis.
A globally unique name for the chassis.
The type of chassis..
The role of the chassis relative to the pnf/pserver..
Operating system of the hardware.
The serial number of the chassis..
The asset tag of the chassis.
Description of the chassis.
Part number for this chassis.
Orchestration status of this chassis.
Equipment model.
Equipment vendor. Source of truth should define valid values.
CLEI or other specification for chassis hardware.
Slot number associated with this chassis.
Reflects the admin-state of the device.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
unique identifier of probe
identifier of probe
type of probe
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
class-of-service of probe
Namespace for cloud infrastructure.
cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.
The cloud-region associated to a geo-region
a cloud-region implements policies
The cloud-region is part of a project (ex, project that built out the cloud region).
The activity applies to a cloud-region.(1)
The contact supports a cloud-region.
The mapping associated to a cloud-region
The network-range is located in a cloud-region
A pnf is located in (aka supports) a cloud-region.
used for CSP pnf to cloud-region.
The validation-audit associated to a cloud-region(1)
A vlan range belongs to a cloud-region.(1)
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
Identifier used by the vendor for the region. Second part of composite key
Type of the cloud (e.g., openstack)
Cloud-owner defined type indicator (e.g., dcp, lcp)
Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
URL of the keystone identity service
Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
Number that maps to the letter at the end of the cloud-region-id.
Function of cloud-region.
Role of cloud-region.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The alias used for this cloud.
Status of cloud-region.
Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc.
Used to indicate whether orchestration is enabled for this cloud-region.
Used to indicate whether or not cloud-region object is in maintenance mode.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
represents the collection resource in the TOSCA model
Collection Object UUID
ASDC model id for this resource or service model
Model Version
collection name
Collection type
Collection Role
Collection function
orchestration status
Captures the id of all the configuration used to customize the resource for the service
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Namespace for common inventory resources.
Requirement of comunication service.
ID of the profile.
The maximum number of UEs may simultaneously access the communication service
A list of TrackingAreas where the NSI can be selected.
The packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance.
User experience data rate of upload.
User experience data rate of download.
User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.
Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of communication service profile.
Collection of physical locations that can house cloud-regions.
The complex associated to a geo-region
A cable is located in a complex.(1)
A chassis LinksTo a complex.
The contact supports a complex.
The network-range is located in a complex
A rack is located in a complex (aka building).(1)
For CCVPN Usecase
Unique identifier for physical location, e.g., CLLI
Data center code which can be an alternate way to identify a complex
Gamma complex name for LCP instance.
URL of the keystone identity service
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Type, e.g., central office, data center.
The time zone where the complex is located.
Collection of physical locations that can house cloud-regions.
Generic configuration object.
The configuration Uses bgp-neighbor.
Relates configuration to network-route for static routes.
A configuration uses a policy
A configuration uses a subnet
A Configuration uses VRFs
UUID assigned to configuration.
Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
Name of the configuration.
port-mirroring-configuration.
vprobe, pprobe.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Orchestration status of the configuration.
Indicator for whether the resource is considered operational.
URL to endpoint where AAI can get more details from SDN-GC.
id of the configuration used to customize the resource
DHV Site Effective Bandwidth
Velocloud Nominal Throughput - VNT
Used to capture the name of the fabric configuration policy that was used to generate the payload sent to PINC for fabric configuration.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Used to categorize the configuration.
Used to categorize the configuration.
Used by some configurations to identify if it's filling a primary role.
Used to categorize the configuration.
Collection of configurations
Collection of connectivities
Instance of a connectivity
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this connectivity by id
Store the name of a bandwidth profile.
Store the type of a bandwidth profile.
Store the CIR of this connectivity.
Store the EIR of this connectivity.
Store the CBS of this connectivity.
Store the EBS of this connectivity.
Store the color-awareness of this connectivity.
Store the coupling flag of this connectivity.
The ethernet service name for this connectivity.
Store the id of the access provider of this connectivity.
Store the id of the access client of this connectivity.
Store the id of the access topology of this connectivity.
Store the id of the access node of this connectivity.
Store the id of the access ltp of this connectivity.
Store the link to get more information for this connectivity.
Store the cvlan for this connectivity.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of resource instances used to connect a variety of disparate inventory widgets
Unique id of resource instance.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Collection of resource instances used to connect a variety of disparate inventory widgets
This is how we would capture constraints defining allowed sets of elements.
Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC
The contact supports a cloud-region.
The contact supports a complex.
The contact supports a pnf.
The contact supports a pserver.
The contact supports a zone.
Name of the contact
Tel no. of contact
e-mail of contact
NI (Network Integrator)SI (System Integrator) 3rd Party LCM
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of contacts
| SE group | This object captures the point of attachment from services or resources to a virtual link or network. | A&AI clients for this object are typically: DCAE-DTI, (DMaaP-DCAE,...) |
AAI-2154 For BBS Usecase
cp is child of vnfc(3)
Unique ID of the connection point.
port index to represent multiple CPs on VNFC connected to same network.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of connection points.
id.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
A collection of C tags (vlan tags) grouped for a specific purpose.
The Target provider edge router
Name of the availability zone
Describes what the intended purpose of this pool is.
Comma separated list of ctags
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
customer identifiers to provide linkage back to BSS information.
service-subscription BelongsTo customer(1)
Global customer id used across ONAP to uniquely identify customer.
Subscriber name, an alternate way to retrieve a customer.
Subscriber type, a way to provide VID with only the INFRA customers.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of customer identifiers to provide linkage back to BSS information.
See mis-na-virtualization-platform.yang
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Instance of a device
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this device by id
Store the esn of this device.
Store the name of this device.
Store the description of this device.
Store the vendor of this device.
Store the class of this device.
Store the type of this device.
Store the version of this device.
Store the system-ip of this device.
Store the system-ipv4 of this device.
Store the system-ipv6 of this device.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of devices
Instance of a dhcp-service
For CCVPN Usecase(3)
Uniquely identifies this dhcp-service by id
Store the server-ip4-address of this dhcp-service.
Store the server-ipv6-address of this dhcp-service.
Store the service-enable of this dhcp-service.
Store the dhcp-service-type of this dhcp-service.
Store the lease-time of this dhcp-service.
Store the domain-name of this dhcp-service.
Store the dns of this dhcp-service.
Store the ntp-primary of this dhcp-service.
Store the ntp-secondary of this dhcp-service.
Store the nbns of this dhcp-service.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of dhcp-services
Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
DVS switch name
URL used to reach the vcenter
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of digital virtual switch metadata used for vmWare VCEs and GenericVnfs.
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.
Metadata for entitlement group.
Unique ID for the entitlement group the resource comes from, should be uuid.
Unique ID of an entitlement resource.
Concurrency value
Entitlements, keyed by group-uuid and resource-uuid, related to license management
Persist EMS address information used by EMS driver.
Unique ID of EMS.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Persist NFVO address information used by VF-C.
Unique ID of nfvo.
indecate the api-root.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Persist common address information of external systems.
For CCVPN Usecase(3)
Unique ID of esr system info.
name of external system.
type of external systems.
vendor of external systems.
version of external systems.
url used to access external systems.
username used to access external systems.
password used to access external systems.
it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
protocol of third party SDNC, for example netconf/snmp.
ca file content if enabled ssl on auth-url.
Whether to verify VIM's certificate.
service IP of ftp server.
service port of ftp server.
domain info for authentication.
default tenant of VIM.
ftp passive mode or not.
resource or performance data file path.
the status of external system.
OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of persistent block-level external system auth info.
Persist SDNC address information used by ONAP SDNC.
For MDONS Usecase(2)
Unique ID of SDNC.
used for DC type to indicate the location of SDNC, such as Core or Edge.
password used to access SDNC server.
Domain type of the SDNC controllerr.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Persist VNFM address information used by VF-C.
Unique ID of VNFM.
indecate the VIM to deploy VNF.
certificate url of VNFM.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
evc object is an optional child object of the Configuration object.
Unique/key field for the evc object
Point-to-Point, Multi-Point
Commited Information Rate
CIR units
Diversity Group ID
formerly Performance Group
EVC Circuit ID of ESP EVC
Committed Information Rate (For ESP)
CIR units (For ESP)
Identifies ESP
Collector POP CLLI (from the hostname of the access pnf)
Interconnect type on ingress side of EVC.
tagode for collector side of EVC
tagMode for network side of EVC
Product ID
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Refer to an external AAI in another ONAP.
For CCVPN Usecase(2)
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Unique ID of the referenced AAI.
Schema version of the referenced AAI.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Namespace for external system.
Extra properties for inventory item for response list
Openstack flavor.
HPA Capacity getting the compute nodes from given 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.
Entity describing a sequenced segment of forwarding path
Points to the generic-vnf(s) involved in this forwarding step.
Unique ID of this segmentation
ingress, intermediate, egress
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
forwarder object is an optional child object of the Configuration object.
Key for forwarder-evc object
Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
Internal VLAN.
SVLAN value for ingress of egress forwarder.
CVLAN value for ingress of egress forwarder.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Entity that describes the sequenced forwarding path between interfaces of services or resources
Unique ID of this FP
Name of the FP
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the self link for this FP
A fully qualified domain name (FQDN) is the complete domain name for a specific computer, or host, on the internet.
The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).
The fqdn that applies to a generic-vnf.
The fqdn that applies to a l3-interface-ipv4-address-list.
The fqdn that applies to a l3-interface-ipv6-address-list.
The fqdn that applies to a vip-ipv4-address-list.
The fqdn that applies to a vip-ipv6-address-list.
The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).
Fully qualified domain name.
Used to categorize this object in conjunction with role & function. The most generic category.
Used to categorize this object in conjunction with type & function.
Used to categorize this object in conjunction with type & role. The most specific category.
Domain name.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
General purpose VNF
The bgp-group associated to a generic-vnf.(2)
The bgp-neighbor associated to a generic-vnf.(2)
For CCVPN Usecase
For CCVPN Usecase
Points to the generic-vnf(s) involved in this forwarding step.
The fqdn that applies to a generic-vnf.
For CCVPN Usecase
AAI-2154 For BBS Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Unique id of VNF. This is unique across the graph.
vnf instance id.
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
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. Valid values are in-service-path and out-of-service-path.
OBSOLETE - do not use
Client should send valid enumerated value
Orchestration status of this VNF, used by MSO.
vnf discriptor name
job id corresponding to vnf
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 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, to be used only by uCPE
units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
number of associated SHD in vnf.
number of vms in vnf.
number of network in vnf.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
used to indicate whether closed loop function is enabled on this node
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
indicates whether generic-vnf access uses SSH
UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
UUID of the specific entitlement resource. OBSOLETE - See child relationships.
UUID of the license assignment group. OBSOLETE - See child relationships.
UUID of the actual license resource. OBSOLETE - See child relationships.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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
Generic description of the type of NF
English description of Network function that the specific VNF deployment is providing
role in the network that this model will be providing
string assigned to this model used for naming purposes
Path to the controller object.
Gateway address
Prefix length for oam-address
Temporary location for S-TAG to get to VCE
Network Management profile of this VNF
VNF instance specific software version
vnf application-id
Collection of VNFs
Top level node for a cg-nat geographical region.
The cloud-region associated to a geo-region
The complex associated to a geo-region
The lag-interface associated to a geo-region
UUID, key for geo-region object.
Name of geo-region
Type of geo-region
Role of geo-region
Function of geo-region
Collection of geo-regions
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
describes an hardware-catalog-items
The cable is this item from the hardware-catalog.
The card is described by the hardware-catalog-item.
The chassis is described by the hardware-catalog-item.
The pdu is described by the hardware-catalog-item.
The pluggable is described by the hardware-catalog-item.
A set of characteristics of the hardware-catalog-item.
The rack is this item from the hardware-catalog.
Unique name for the hardware-catalog-item
Type of system defined by ATT
Manufacturer of the hardware-catalog-item (ex,Cisco)
Model of the hardware-catalog-item (ex,5501 NCS)
Part number assigned by the manufacturer
Description of the hardware-catalog-item
Stock-keeping-unit (ATT specific identifier for the hardware-catalog-item)
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of hardware-catalog-items
describes an hostAggregates
Unique identifier for the host-aggregate.
Name of the host-aggregate.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of HostAggregates.
host-route id
subnet prefix
Could be ip-address, hostname, or service-instance
Should be ip-address, hostname, or service-instance to match next-hop
Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of HPA Capabilities
Represents a HPA capability
UUID to uniquely identify a HPA capability
Name of the HPACapability
HPA schema version
Hardware architecture
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
HPA Capacity information for compute node
HPA Capacity KV for given compute node(4)
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check
JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
HPA Capability Feature attributes
name of the specific HPA attribute
JSON string specifying the value, unit and type of the specific HPA attribute
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
create/update/delete the hw-component node
The profile associated to a hw-component
The hw-component associated to a pnf
The hw-component associated to a pserver
UUID
Name of hardware component
Type of hardware component
Role of hardware component
Function of hardware component
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
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
General mechanism for grouping instances
The instance-group associated to an instance-group
The instance-group associated to an instance-group
The mapping associated to an instance-group
The policy associated to an instance-group
A profile (set of characteristics) applies to the instance-group (as a vrrp group).
The rack is a member of the instance-group (rack-group or pod).
MSO creates this edge on VNF Group Service creation
Instance Group ID, UUID assigned to this instance.
role of the instance group.
ASDC model id for this resource or service model.
ASDC model version uid for this resource model.
Descriptive text to help identify the usage of this instance-group
Only valid value today is lower case ha for high availability
Concurrency value
Instance-Group Name.
Instance-Group Function
Number used to identify an instance-group
Used to identify the primary and secondary priority
Collection of openstack route table references
Instance of an inter layer topology attachment
For CCVPN Usecase(1)
For CCVPN Usecase(1)
Id that identifies the interlayer topology attachment
Inter layer lock id
Store the link to get more information for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of interlayer topology connectivities.
Inventory item for response list
Container for inventory items in response list
IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
UUID of this configuration
Indicate the type of VIG server like AVPN, INTERNET, BOTH
Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
Shared DMZ or a DMZ specific to a customer
Network address of shared DMZ
If the DMZ is a custom DMZ, this field will indicate the customer information
can be 1 or 2
Contains values like md5, sha1, sha256, sha384
Encyption values like 3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc
Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
Group name defined in VIG for clients using aggressive mode
pre-shared key for the above group name
Lifetime for IKEv1 SA
md5, sha1, sha256, sha384
3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc
Life time for IPSec SA
enable PFS or not
user ID for xAuth, sm-user,ucpeHostName,nmteHostName
Encrypted using the Juniper $9$ algorithm
The time between DPD probe
Maximum number of DPD before claiming the tunnel is down
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Logical interfaces, e.g., a vnic.
The l-interface that is used by the next-hop.
A logical interface associated with a pnf.(4)
A logical interface associated with a pserver.(4)
An sub-interface that uses a vlan-tag.
The policy applies to an l-interface.
A profile (set of characteristics) applies to the l-interface.
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
Human friendly text regarding this interface.
type to sub-classify the l-interface (ex, loopback)
boolean indicatating whether or not port is a mirrored.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
Flag indicating the interface uses the IP Unnumbered configuration.
Freeform field for storing an ip address, list of ip addresses or a subnet block.
Priority used for fail-over. Valid values 1-1024, with 1 being the highest priority.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this Linterface
Identifies l2-multicasting support on an l-interface. true indicates that l2-multicasting is supported; defaulted to false .
Administrative status of the interface. Valid values are 'up', 'down', or 'testing'.
Collection of logical interfaces.
IPv4 Address Range
A IPv4 address associated with a lag-interface.(4)
A IPv4 address associated with a p-interface.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a l3-interface-ipv4-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the l3-interface-ipv4-address-list of an R-Leaf's l-interface that is for VLAN 2
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
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
IPv6 Address Range
A IPv6 address associated with a lag-interface.(4)
A IPv6 address associated with a p-interface.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a l3-interface-ipv6-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the l3-interface-ipv6-address-list of an R-Leaf's l-interface that is for VLAN 2
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
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Generic network definition
l3-network uses l3-network
Relates l3-network to network-route for static routes.
A l3-network Uses vlan-tag.
l3-network uses l3-network
A policy applies to l3-networks.
A profile (set of characteristics) applies to the l3-network.
A vrf uses many l3-networks
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?
text used for documentation
Neutron network id of this Interface
Set to true if bound to VPN
Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
network role instance
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Contrail FQDN for the network
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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.
boolean indicatating whether or not network is a provider network.
boolean indicatating whether or not network is a shared network.
boolean indicatating whether or not network is an external network.
Path to the controller object.
Indicator for whether the resource is considered operational.
Trunked network indication.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this l3 network
Instance of an label restriction
For CCVPN Usecase(4)
Id that identifies the label restriction
First number in the label range
Last number in the label range
Bitmap of available labels starting from label-start to label-end.
Step of labels in label range.
Indicate wheather range-bitmap items are inclusive or exclusive.
Indicate the label range e.g.trib-slot, trib-port
Indicate trib slot granularity.
Priority.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of Label Restriction.
Link aggregate interface
The lag-interface associated to a geo-region
A IPv4 address associated with a lag-interface.(1)
A IPv6 address associated with a lag-interface.(1)
A profile (set of characteristics) applies to the lag-interface.
Name that identifies the link aggregate interface
Human friendly text regarding this 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
ID of interface
Role assigned to this Interface, should use values as defined in ONAP Yang models.
Trigger for operational monitoring of this resource by Service Assurance systems.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
The system id used by the LACP protocol.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this Lag interface
Minimum links in service before a LAG should be taken out of service
Collection of link aggregate interfaces.
LAG links can connect lag-interfaces
Alphabetical concatenation of lag-interface names
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of link aggregation connections
Instance of a lan-port-config
For CCVPN Usecase(2)
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this lan-port-config by id
Store the name of this lan-port-config.
Store the description of this lan-port-config.
Store the device-id of this lan-port-config.
Store the port-id of this lan-port-config.
Store the ipv4-address of this lan-port-config.
Store the ipv6-address of this lan-port-config.
Store the vlan-tag of this lan-port-config.
Store the input-bandwidth of this lan-port-config.
Store the output-bandwidth of this lan-port-config.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of lan-port-configs
Metadata for license group.
A license belongs to a chassis.(4)
Unique ID for the license group the resource belongs to, should be uuid.
Unique ID of a license resource.
Used to store CFAS or other project numbers.
Order number.
Date of receipt.
Concurrency value
Licenses to be allocated across resources, keyed by group-uuid and resource-uuid, related to license management
describes a line-of-business
A line-of uses a vlan-range
The line-of-business associated to a validation-audit
Name of the line-of-business (product)
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of lines-of-business
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
For CCVPN Usecase
The port associated with a logical-link(2)
For CCVPN Usecase(4)
A policy applies to a bgp-neighbor.
A profile (set of characteristics) applies to the logical-link.
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
Type of logical link, e.g., evc
Captures the numeric part of the speed
Captures the units corresponding to the speed
Captures the units corresponding to the speed
Captures the administrative state of the link
v4, v6, or ds for dual stack
For example, static or BGP
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC 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.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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.
Circuit id
Reason for this entity, role it is playing
A description for the logical-link.
A segment-id assigned to the logical-link (ex, esi for ethernet segments).
The function performed by this logical link
Collection of logical connections
General mechanism for mapping between instances; cg-nat.
The mapping associated to a cloud-region
The mapping associated to an instance-group
The mapping associated to a mapping
The mapping associated to a mapping
The mapping associated to a pnf
The mapping associated to a policy
The reservation information associated with a NAT Pool mapping.
The mapping associated to a mapping
The mapping associated to a mapping
Key for mapping object.
Name of mapping
Type of mapping.
Role of mapping
Function of mapping
Number of mapping
Location 1
Location 2
Non-unique ID for grouping mappings
Provision status for the mapping object. Valid values can be found at (https://wiki.web.att.com/display/SPTIIRP/prov-status).
Location the object is homed to
Location the object is planned for
Collection of mappings.
Collection of metadatum (key/value pairs)
Key/value pairs
AAI-2154 For BBS Usecase
AAI-2154 For BBS Usecase
AAI-2154 For BBS Usecase
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, independent of version
Unique identifier corresponding to the main definition of a model in ASDC
Type of the model, e.g., service, resource, widget, etc.
Role of the model,e.g.,NST,NSST,CST,etc
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.
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.
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.
Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
Unique identifier corresponding to one version of a model in ASDC
Name of the model, which can change from version to version.
Version
Distribution Status
Description
The CDS blue print name associated with the resource.
The version of the CDS blue print.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of subgraph definitions provided by ASDC to describe the inventory assets and their connections related to ASDC models
Unique id of multicast configuration.
protocol of multicast configuration
rp type of multicast configuration
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
multicast configuration of generic-vnf ip-address
TBD
TBD
Namespace for network inventory resources.
UUID representing unique key to this instance
Contrail FQDN for the policy
ID for the openStack Heat instance
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Name of the policy
Type of the policy
The packet transmission latency (millisecond) through the Transport slice connections and is used to evaluate utilization performance of the end-to-end network slice instance.
jitter
The maximum bandwidth (mb) of the connection links in a transport slice instance.
Network profile populated by SDN-GP for SNMP
Unique name of network profile.
Encrypted SNMP community string
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of network profiles
Description of Network Range
The network-range is located in a cloud-region
The network-range is located in a complex
The network-range is located in a zone
An activity is being performed on a network-range.(1)
UUID
name
type (ex, esi, vni, vni-rt, lacp-id).
role of network-range
descriptive function
starting range for simple network ranges.
end range for simple network ranges.
last assigned value for simple network ranges
Format Decimal, Hexadecimal, etc.
Prefix of network range.
Concurrency value
Collection of Network Ranges
Instance of a network-resource
For CCVPN Usecase
For CCVPN Usecase
For MDONS Usecase(3)
For CCVPN Usecase(1)
Uniquely identifies this network-resource by id
Store the id of the provider of this network-resource.
Store the id of the client of this network-resource.
Store the id of the te-topo of this network-resource.
Type of a network topology, e.g., Ethernet, OTN, WSON.
Store the link to get more information for this object.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of network-resources
This object represents a network route. For instance, host-route, static-route.
The network-route that is used by the next-hop.
The route is part of part of a subnet.
Relates configuration to network-route for static routes.
Relates l3-network to network-route for static routes.
Relates vrf to network-route for static routes.
unique identifier example uuid.
used to categorize this object in conjunction with role & function. The most generic category.
used to categorize this object in conjunction with type & function.
used to categorize this object in conjunction with type & role. The most specific category.
ip address that of the specific network-route.
ip-address prefix length.
Identity of a logical interface, e.g., VLAN ID.
Could be ip-address, hostname, or service-instance.
Should be ip-address, hostname, or service-instance to match next-hop.
Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.
whether the route address is ipv4, ipv6.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
The network-technology object is used to capture the supported network technologies of a cloud-region.
The network-technology object is used to capture the supported network technologies of a cloud-region.
Unique identifier of the network-technology object (UUID)
The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
Unique id of VNF, can't use same attribute name right now until we promote this new object
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
Indicator for whether the resource is considered operational
OBSOLETE - do not use
Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
Client should send valid enumerated value.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
v4 Loopback0 address
Orchestration status of this VNF, mastered by MSO.
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
Is among the series of routers that are connected together in a network and is the next possible destination for a data packet.
The l-interface that is used by the next-hop.
The network-route that is used by the next-hop.
The rule that is used by the next-hop. For CG-NAT these are the ACL policies.
The vrfs that are used by the next-hop.
UUID.
Used to categorize this object in conjunction with role & function. The most generic category.
Used to categorize this object in conjunction with type & function.
Used to categorize this object in conjunction with type & role. The most specific category.
Sequence number.
Ipv4 or Ipv6.
Next hop ip-address.
Cost that is associated with using the route.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
nos-server is the execution environment that will have images, certain versions of VNOS, running on it.
Unique identifier for this nos relative to its tenant
Name of nos
uCPE vendor
Trigger for operational monitoring of this resource by Service Assurance systems.
URL to endpoint where AAI can get more details
Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
nos-server is the execution environment that will have images, certain versions of VNOS, running on it.
OAM network, to be deprecated shortly. Do not use for new purposes.
UUID of the network. Unique across a cloud-region
Name of the network.
cvlan-id
Used for VNF firewall rule so customer cannot send customer traffic over this oam network
Used for VNF firewall rule so customer cannot send customer traffic over this oam network
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of OAM networks, to be deprecated shortly. Do not use for new purposes.
It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
UUID of an operational environment
Operational Environment name
Operational Environment Type.
Status
Tenant Context.
Workload Context.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
a logical partition of the cloud which allows to have multiple environments in the production AIC.
Allows for legacy POST of old-style and new-style models
Unique identifier corresponding to the main definition of a model in ASDC
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.
Collection of owning-entities
describes an owning-entity
An owning-entity uses a vlan-range.
service-instance Uses an owning-entity
UUID of an owning entity
Owning entity name
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Physical interface (e.g., nic)
For CCVPN Usecase(4)
For CCVPN Usecase(4)
The activity applies to a p-interface.(1)
AAI-1925 For CCVPN Usecase
For MDONS usecase(1)
A IPv4 address associated with a p-interface.(1)
A IPv6 address associated with a p-interface.(1)
A port is composed of one or more p-interfaces.(3)
A profile (set of characteristics) applies to the p-interface.
For MDONS Use case
For CCVPN Usecase
For CCVPN Usecase
Name that identifies the physical interface
Alternate name that identifies the physical interface
URL to endpoint where AAI can get more details.
Captures the numeric part of the speed
Captures the units corresponding to the speed
Nature of the services and connectivity on this port.
Domain type of the SDNC controllerr.
CLEI or other specification for p-interface hardware.
Role specification for p-interface hardware.
Indicates the physical properties of the interface.
Indicates the physical properties of the interface.
Trigger for operational monitoring of this resource by Service Assurance systems.
MAC Address of the p-interface.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
inventory status
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this pInterface
MAC address for the interface
Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point.
Store the transparent value of this p-interface.
oper Status of this p-interface.
connect interdomain link
Collection of physical interfaces.
Definition of pdu
The pdu is described by the hardware-catalog-item.
A pdu is located in a building (aka complex).(4)
A pdu uses space in a rack (aka one or more rack-units).
The profile (set of characteristics) applies to the pdu.
A unique name for the power distribution unit.
The type of pdu.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of physical connections, typically between p-interfaces
A cable is composed of one or more physical-links.
A profile (set of characteristics) applies to the physical-link.
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.
Upstream Bandwidth value agreed with the service provider
Units for the upstream BW value
Downstream Bandwidth value agreed with the service provider
Units for downstream BW value
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
The function performed by this physical link
Indicator for the use of this physical link
Subtype used to categorize this physical link
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Collection of physical connections, typically between p-interfaces
describes a platform
Name of the platform
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of platforms
Definition of pluggable
A pluggable that is intergrated with a cable.(4)
The pluggable is described by the hardware-catalog-item.
A pluggable is located in a pluggable-slot.(4)
A port is located in a pluggable.(1)
The profile (set of characteristics) applies to the pluggable.
The type of pluggable.
Part number for this pluggable.
CLEI or other specification for pluggable hardware.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of card-slot
A pluggable slot is located in a card.(4)
A pluggable-slot is located in a chassis.(4)
A pluggable is located in a pluggable-slot.(1)
The name of the pluggable-slot. (unique relative to the chassis or card).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
pnf is located in the autonomous-system.
A pnf is located in (aka supports) a cloud-region.
used for CSP pnf to cloud-region.
For CCVPN Usecase
The hw-component associated to a pnf
For CCVPN Usecase(4)
A pnf uses policies
The pnf is part of a project (ex, VPMO that ordered the equipment).
The sw-component associated to a pnf
The activity applies to a pnf.(1)
A bgp-group belongs to a pnf.(1)
A bgp-neighbor belongs to a pnf.(1)
A chassis is part of a pnf.
The contact supports a pnf.
A logical interface associated with a pnf.(1)
The mapping associated to a pnf
AAI-2154 For BBS Usecase
A profile (set of characteristics) applies to the pnf.
For CCVPN Usecase(1)
A vrf belongs to a pnf.(1)
unique name of Physical Network Function.
name of Physical Network Function.
URL to endpoint where AAI can get more details.
source of name2
id of pnf
Naming code for network function
Network operating system used on the device.
The function performed by the 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 customer
Orchestration status of this pnf
ipv4-oam-address with new naming convention for IP addresses
sw-version is the version of SW for the hosted application on the PNF.
Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
ID of the physical frame (relay rack) where pnf is installed.
Serial number of the device
IPV4 Loopback 0 address
IPV6 Loopback 0 address
IPV4 AIM address
IPV6 AIM address
IPV6 OAM address
CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
Nf Role is the role performed by this instance in the network.
admin Status of this PNF
Store the operational-status for this object.
Store the model-customization-id for this object.
The ASDC model id for this resource model.
The ASDC model version for this resource model.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Contains the value of the request id to the most recent configuration file/validation report for this PNF.
Status of latest configuration attempt represented by the config-url.
Subtype used to categorize this pnf
Indicates the PNF/R-Leaf was built with the VNF agnostic common base
11-character equipment CLLI.
This is the IP address (IPv4) for the PNF itself. This is the IPv4 address that the PNF iself can be accessed at.
This is the IP address (IPv6) for the PNF itself. This is the IPv6 address that the PNF iself can be accessed at.
Collection of Physical Network Functions.
Definition of policy
A policy applies to an address family.
A policy applies to a bgp-group.
A policy applies to a bgp-neighbor.
The policy associated to an instance-group
The policy applies to an l-interface.
A policy applies to l3-networks.
This edge allows for QOS policy to vlan-tag relationship. For a given policy get all vlan tags as well as for a given vlan-tag get all the policies.
A policy uses vpn-bindings
a cloud-region implements policies
A configuration uses a policy
An ip-address-list BelongsTo a policy.(1)
The mapping associated to a policy
A pnf uses policies
A profile (set of characteristics) applies to the policy.
Details relationships policy requires.
Unique Policy UUID.
Policy Name
Policy Type
Policy role
policy function
Do not track
Pre destination NAT
apply on forward
Host and Interface Type Selector
Order
Version
Status
Remote ASN
Namespace filter to apply the policy
Description of the policy
Set of rule variables
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of port
A channel-interface terminates a channel-link.
A port is located in a card.(4)
A port is LocatedIn a chassis.(4)
A port is composed of one or more p-interfaces.(2)
A port is located in a pluggable.(4)
A port LinksTo another port.
The port associated with a logical-link(3)
A port LinksTo another port.
A unique name for the port relative to the containing hardware.
The type of port.
The role of the port.
The numeric value for the speed of the port.
The units for the speed of the port.
Type of transceiver that creates this port.
clei-code or other similar identifier
part number
Port range start
Port range end
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Used to capture the network interfaces of this VCE
Unique ID of the interface
Neutron network id of this Interface
Neutron network name of this Interface
Role assigned to this Interface, should use values as defined in ECOMP Yang models.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Unique ID for port group in vmware
Likely to duplicate value of neutron network name
DVS or standard switch name (should be non-null for port groups associated with DVS)
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Port List Range
Port number
Name or assignment for the port
Type or usage of the port
Operator to apply to the port (greater than, less than, etc).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
describes an profiles
The profile (set of characteristics) applies to the card.
The profile (set of characteristics) applies to the chassis.
A set of characteristics of the hardware-catalog-item.
A profile (set of characteristics) applies to the instance-group (as a vrrp group).
A profile (set of characteristics) applies to the l-interface.
A profile (set of characteristics) applies to the l3-network.
A profile (set of characteristics) applies to the lag-interface.
A profile (set of characteristics) applies to the logical-link.
A profile (set of characteristics) applies to the p-interface.
The profile (set of characteristics) applies to the pdu.
A profile (set of characteristics) applies to the physical-link.
The profile (set of characteristics) applies to the pluggable.
A profile (set of characteristics) applies to the pnf.
A profile (set of characteristics) applies to the policy.
A profile (set of characteristics) applies to the pserver.
The profile (set of characteristics) applies to the rack.
A profile (set of characteristics) applies to the subnet.
A profile (set of characteristics) applies to the vlan-range.
A profile (set of characteristics) applies to the vlan-tag.
A profile (set of characteristics) applies to the vpn-binding.
A profile (set of characteristics) applies to the vrf.
The profile associated to a hw-component
Details relationships profile requires.
The profile associated to a sw-component
Name of the profile
Type of profile (ex,network-power-profile)
Set of characteristics of the profile.
Descriptive subtype.
used to categorize this object in conjunction with profile-type and profile-function.
used to categorize this object in conjunction with profile-type and profile-role. The most specific category
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 profiles
describes the project
The cloud-region is part of a project (ex, project that built out the cloud region).
The pnf is part of a project (ex, VPMO that ordered the equipment).
The pserver is part of a project (ex, VPMO that ordered the equipment).
Name of the project deploying a service
Type of project (ex, VPMO)
Current state of the project.
Description of the project.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of projects
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.
The hw-component associated to a pserver
The pserver is part of a project (ex, VPMO that ordered the equipment).
The sw-component associated to a pserver
The activity applies to a pserver.(1)
A chassis is part of a pserver.
The contact supports a pserver.
HPA Capacity getting the compute nodes from given flavor
HPA Capacity KV for given compute node(1)
A logical interface associated with a pserver.(1)
A profile (set of characteristics) applies to the pserver.
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
IPV4 Loopback 0 address
IPV6 Loopback 0 address
IPV4 AIM address
IPV6 AIM address
IPV6 OAM address
CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
ID of Pserver
internet topology of Pserver
used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
alternative pserver name
purpose of pserver
Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
Indicates who owns and or manages the device.
The host profile that defines the configuration of the pserver.
The role performed by the pserver.
The function performed by the pserver.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Collection of compute hosts.
QueryParameters for performing a named-query or model query
Definition of rack
A rack is located in a complex (aka building).(4)
The rack is this item from the hardware-catalog.
The rack is a member of the instance-group (rack-group or pod).
A chassis is LocatedIn a rack.
A pdu is located in a building (aka complex).(1)
The profile (set of characteristics) applies to the rack.
A rack-unit is located in a rack.(1)
A unique name for the rack (within the location).
The type of rack.
The location of the rack within the building.
The position of the rack (ex-floor-mounted).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Definition of rack-unit
A rack-unit is located in a rack.(4)
A chassis uses space in a rack (aka one or more rack-units).
A pdu uses space in a rack (aka one or more rack-units).
A unique name for the rack-unit (within the rack).
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
dictionary of relationship
describes an relationship component
Defines the traversal needed to reach the node of relationship-rule(4)
NARAD object
Object property
Property value
Order in traversal
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of relationship components
A keyword provided by A&AI to indicate an attribute.
Value of the attribute.
A keyword provided by A&AI to indicate type of node.
The edge label for this relationship.
URL to the object in A&AI.
describes an relationship rule
Details relationships policy requires.
Details relationships profile requires.
Defines the traversal needed to reach the node of relationship-rule(1)
UUID.
Example global,site
Number of traversals
Node the related object applies to
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of relationship rules
Internal map to define some reserved properties of a vertex
Response container for the results of a named-query or model query
The specific type of node in the A&AI graph
The URL to the specific resource
Openstack route table reference.
Route Table Reference id, UUID assigned to this instance.
FQDN entry in the route table.
Concurrency value
Collection of openstack route table references
Route target information
Number used to identify an RT, globally unique in the network
Role assigned to this route target
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of route target information
Unique id of routing instance
rpm owner
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
set of probes related to generic-vnf routing instance
describes an rules
The rule that is used by the next-hop. For CG-NAT these are the ACL policies.
UUID.
ingress or egress
Positive protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.
Negative protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.
Action to perform when matching this rule.
Sequence number of the rule.
Threshold
status
Version
Named variable used for counting transactions.
Boolean to indicate whether or not logging is required.
Description.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of rules
Instance of an sdwan-vpn
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this sdwan-vpn by id
Store the name of this sdwan-vpn.
Store the vxlan-id of this sdwan-vpn.
Store the topology of this sdwan-vpn.
Store the tenant-id of this sdwan-vpn.
Store the vpn-id of this sdwan-vpn.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of sdwan-vpns
SecondaryFilts for performing a named-query or model query
Openstack segmentation assignment.
Route Table Reference id, UUID assigned to this instance.
Concurrency value
Collection of openstack segmentation assignments
Selectors list
Selector
Name or assignment for the selector
Type or usage of the selector
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
This gets defined by others to provide a unique ID for the service, we accept what is sent.
Description of the service
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
service version
Collection of service capabilities.
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
This gets defined by others to provide a unique ID for the service, we accept what is sent.
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Namespace for objects managed by ASDC
Instance of a service
MSO creates this edge on VNF Group Service creation
service-instance Uses an owning-entity
For MDONS Use case
This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this instance of a service
This field will store a name assigned to the service-instance.
String capturing type of service.
String capturing the service role.
Rate of the service instance.
Definition of the service layer.
Due date of the service creation.
End date of the service creation.
This field will store the environment context assigned to the service-instance.
This field will store the workload context assigned to the service-instance.
create time of Network Service.
last update of Network Service.
short description for service-instance.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Indicates the total bandwidth to be used for this service.
indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
URL customers will use to access the vHN Portal.
An identifier that customers assign to the location where this service is being used.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Path to the controller object.
Orchestration status of this service.
String capturing request parameters from SO to pass to Closed Loop.
String capturing function of the service.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Collection of service instances
Requirement of E2E Slice service.
ID of the profile.
The packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance.
The maximum number of UEs may simultaneously access the E2E slice service
A list of TrackingAreas where the NSI can be selected.
User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.
Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).
Percentage value of the amount of simultaneous active UEs to the total number of UEs where active means the UEs are exchanging data with the network.
The jitter requirements of network slice.
An attribute specifies the time that an application consuming a communication service may continue without an anticipated message.
An attribute specifies in the context of network layer packet transmissions, percentage value of the amount of sent network layer packets successfully delivered to a given system entity within the time constraint required by the targeted service, divided by the total number of sent network layer packets.
This attribute defines achievable data rate of the network slice in downlink that is available ubiquitously across the coverage area of the slice.
This attribute defines downlink data rate supported by the network slice per UE.
This attribute defines achievable data rate of the network slice in uplink that is available ubiquitously across the coverage area of the slice.
This attribute defines uplink data rate supported by the network slice per UE.
This parameter specifies the maximum packet size supported by the network slice.
This parameter defines the maximum number of concurrent sessions supported by the network slice.
An attribute specifies the overall user density over the coverage area of the network slice.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of E2E slice service profile.
Object that group service instances.
service-subscription BelongsTo customer(4)
Value defined by orchestration to identify this service across ONAP.
This property will be deleted from A&AI in the near future. Only stop gap solution.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of objects that group service instances.
Collection of service model definitions. Likely to be deprecated in favor of models from ASDC.
unique identifier of probe
Prefix address
Prefix address
ip version, v4, v6
Hostname of the destination equipment to which SLAs are measured against.
The type of destinatination equipment. Could be Router, UCPE, etc.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Set of instances for probes used to measure service level agreements
Unique id of site pair set.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of sets of instances for probes related to generic-vnf
probe within a set
Instance of a site-resource
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this site-resource by id
Store the name of this site-resource.
Store the description of this site-resource.
Store the type of this site-resource.
Store the role of this site-resource.
Store the generated-site-id of this site-resource.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of site-resources
Requirement of network slice subnet service.
ID of the profile.
The packet transmission latency (millisecond) through the RAN or CN or TN and is used to evaluate utilization performance of the end-to-end network slice instance.
The maximum number of UEs may simultaneously access the slice subnet service
A list of TrackingAreas where the NSSI can be selected.
User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.
Whether the resources to be allocated to the slice subnet instance may be shared with another network slice instance(s).
User experience data rate of upload.
User experience data rate of download.
The area traffic capbility of upload.
The area traffic capbility of download.
An attribute specfies the percentage value of the amount of simultaneous active UEs to the total number of UEs where active means the UEs are exchanging data with the network.
The jitter requirements of network slice subnet.
Survival time for network slice subnet.
Maxmun bandwidth value of TN network.
Expected date rate for uRLLC.
maxNumberofPDUSession Integer 1 The maximum number of PDU sessions that can simultaneously/concurrently access to the network slice.
Overall User Density.
Communication service reliability mean time between failures.
Message size(byte) .
transferIntervalTarget String 1 Target value of transfer interval.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of slice subnet service profile.
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
Software Version
Identifier of the software version
used to indicate whether or not this software-version is the active one (activeSw = true)
Collection of software versions.
Instance of an sp-partner
For CCVPN Usecase
Uniquely identifies this sp-partner by id
Store the URL of this sp-partner.
Store the callsource of this sp-partner.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Store the operational-status for this sp-partner.
Store the model-customization-id for this sp-partner.
the ASDC model id for this sp-partner model.
the ASDC model version for this sp-partner model.
Collection of sp-partners
SR-IOV Physical Function
Identifier for the sriov-pf
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of SR-IOV Physical Functions.
SR-IOV Virtual Function (not to be confused with virtual network function)
PCI ID used to identify the sriov-vf
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Neutron network id of the interface
Collection of SR-IOV Virtual Functions.
A fabric subnet belongs to a zone.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor belongs To a subnet.(1)
A configuration uses a subnet
The route is part of part of a subnet.
A profile (set of characteristics) applies to the subnet.
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
text used for documentation
dhcp enabled
the start address reserved for use by dhcp
the last address reserved for use by dhcp
role of the subnet, referenced when assigning IPs
subnet model BGP, VRPP
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Subtype used to categorize this physical link
The function performed by this Linterface
ip address assignment direction of the subnet
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
sequence of the subnet
create/update/delete the sw-component node
The profile associated to a sw-component
The sw-component associated to a pnf
The sw-component associated to a pserver
The sw-component associated to a vserver
UUID
Name of software component
Type of software component
Role of software component
Function of software component
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Instance of an te-link-attribute
For CCVPN Usecase(1)
For CCVPN Usecase(1)
Id that identifies the TE link attribute
Indicate desired protection type of the link e.g, unprotected, shared or 1+1
Indicate link access type e.g, point-to-point or multi-access.
Bandwidth available on link.
The type of ODU e.g, ODU1, ODU2, ODU3, ODU4.
The value of available bandwidth.
Indicate wheather link is abstract or native
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of TE link attributes.
Openstack tenant
For CCVPN Usecase
Unique id relative to the cloud-region.
Readable name of tenant
This field will store the tenant context.
tenant parent-id
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of openstack tenants.
Instance of an tunnel termination point
For CCVPN Usecase(4)
For CCVPN Usecase(4)
For CCVPN Usecase(1)
Id that identifies the tunnel termination point
TTP ID discovered from controller
Name of tunnel termination point
Admin status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.
Operational status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.
Indicate switching capability of TTP e.g,PSC-1, EVPL,L2SC,TDM,OTN.
Encoding support by the TTP e.g, packet,ethernet,PDH,SDH,digital-wrapper,lambda,fiber,ODUK,line.
Indicate supported protection type of this TTP e.g, unprotected,reroute,reroute-extra,1-for-n,unidir-1-to-1.
correlation between related objects in ETH and OTN topology.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of Tunnel Termination Point.
Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
Allotted Resource id UUID assigned to this instance.
Concurrency value
This object is used to store the specific tunnel cross connect aspects of an allotted resource
Instance of an User network interface
For CCVPN Usecase
For CCVPN Usecase
Id that identifies the UNI
Termination point ID.
The cvlan for the site used for ethernet type connectivity.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of User network interface.
Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
validation audit, value of validation status
The validation-audit associated to a cloud-region(4)
The line-of-business associated to a validation-audit
Validation-Audit UUID
Request-id to retrieve data from client related to the specified audit
Status of the audit
Phase in the lifecycle of the configuration
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of validation-audit
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
Unique id of VNF. This is unique across the graph.
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures.
Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
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
OBSOLETE - do not use
Network role being played by this VNF
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Unique ID of VPE connected to this VCE.
Valid v6 IP address for the WAN Link on this router. Implied length of /64.
Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Loopback0 address
OBSOLETE - see child relationships
Collection of Virtual Customer Edge Routers, used specifically for Gamma. This object is deprecated.
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 to indicate whether or not this object is base vf module
Indicates whether vf-module assignment was done via automation or manually
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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
the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
Path to the controller object.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Collection of vf-modules, a deployment unit of VNFCs
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
indicates whether the VIG is for AVPN or INTERNET
v4 IP of the vig server
v6 IP of the vig server
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
IPv4 Address Range
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a vip-ipv4-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the vip-ipv4-address-list of an R-Leaf's l-interface that is for VLAN 2
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
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
IPv6 Address Range
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a vip-ipv6-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the vip-ipv6-address-list of an R-Leaf's l-interface that is for VLAN 2
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
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Virtual organization of cloud infrastructure elements in a data center context
Unique ID of the vdc
Name of the virtual data center
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Virtual organization of cloud infrastructure elements in a data center context
Definition of vlan
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
The type of vlan (eg. vxlan)
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
Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
Flag indicating the interface uses the IP Unnumbered configuration.
Private VLAN indicator.
describes an vlan characteristic
UUID.
Name.
Device role the vlan-characteristic applies to (c-agg-leaf-a, c-agg-leaf-b, r-leaf).
DHCP Agent access.
Boolean to represent if requires internet access.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of vlan characteristics
vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects.
Key for vlan-mapping object.
CVLAN value from the UNI/ingress side of the SAREA gateway access device.
SVLAN value from the NNI/egress side of the SAREA gateway access device.
CVLAN value from the NNI/egress side of the SAREA gateway access device.
The internal VLAN ('IVLAN') value. Specific to Arista devices.
Collection of vlan mappings.
Definition of vlan range
A vlan range belongs to a cloud-region.(4)
A line-of uses a vlan-range
An owning-entity uses a vlan-range.
A profile (set of characteristics) applies to the vlan-range.
A vlan-tag belongs to a vlan-range.(1)
vlan id in range UUID.
vlan id in range lower
vlan id in range upper
vlan type
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
vlan tag information
A vlan-tag belongs to a vlan-range.(4)
An sub-interface that uses a vlan-tag.
A l3-network Uses vlan-tag.
This edge allows for QOS policy to vlan-tag relationship. For a given policy get all vlan tags as well as for a given vlan-tag get all the policies.
A profile (set of characteristics) applies to the vlan-tag.
Vlan Tag Id
Role assigned to this vlan-tag
Inner VLAN tag
Outer VLAN tag
is private flag.
VLAN tag Type
VLAN Tag Function
The config-phase associated with this vlan-tag
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
Unique ID of this asset
The application that the image instantiates.
The vendor of the application.
The version of the application.
URL to endpoint where AAI can get more details
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of image objects that pertain to a VNF that doesn't have associated vservers. This is a kludge.
cp is child of vnfc(2)
Unique ID of vnfc.
Short code that is used in naming instances of the item being modeled
English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
prov status of this vnfc
Orchestration status of this VNF, mastered by APP-C
Oam V4 vip address of this vnfc
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
used to indicate whether closed loop function is enabled on this node
Group notation of VNFC
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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 SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures.
Orchestration status of this volume-group
captures the id of all the configuration used to customize the resource for the service.
helps relate the volume group to the vf-module whose components will require the 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.
VPLS Provider Edge routers.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
Client should send valid enumerated value, e.g., VPLS-PE.
Temporary location for stag to get to VCE
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of VPLS Provider Edge routers
VPN binding
A vpn-binding uses many aggregate routes
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
A policy uses vpn-bindings
A profile (set of characteristics) applies to the vpn-binding.
For CCVPN Usecase
A vrf uses a vpn-binding.
VPN ID, globally unique within A&AI
VPN Name
the platform associated with the VPN example AVPN, Mobility
Type of the vpn, should be taken from enumerated/valid values
region of customer vpn
id for this customer vpn
Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
Store the id of the access provider of this vpn.
Store the id of the access client of this vpn.
Store the id of the access topology of this vpn.
Store the id of the src-access-node of this vpn.
Store the id of the src-access-ltp of this vpn.
Store the id of the dst-access-node of this vpn.
Store the id of the dst-access-ltp of this vpn.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Max prefix for IPv4.
Max prefix for IPv6.
Max prefix threshold.
Label mode for IPv4.
Label mode for IPv6.
The description of the vpn.
A VNI associated with the VPN.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
A variable BGP max AS path length.
Definition of vrf
A vrf uses many l3-networks
Relates vrf to network-route for static routes.
The vrfs that are used by the next-hop.
A vrf belongs to a pnf.(4)
A vrf uses a vpn-binding.
An aggregate-route BelongsTo a vrf.(1)
A bgp-group belongs to a pnf.(1)
A bgp-neighbor belongs to a vrf.(1)
A Configuration uses VRFs
A profile (set of characteristics) applies to the vrf.
This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.
VRF UUID.
VRF Name
VRF Description
Route Distinguisher
The type of vrf (bridge-domain as an example)
IP address family (v6/v4/both)
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Indicator for the use of this physical link
The function performed by this Linterface
Bridge domain group name
Virtual Servers, aka virtual machine or VM.
The sw-component associated to a vserver
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 to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
Used to indicate whether closed loop function is enabled on this node
Non-uniform memory access optimization, helps prevent memory-bandwidth bottlenecks. Expected values - 1 or 2 identifying memory access
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Collection of virtual Servers, aka virtual machines or VMs.
Instance of a wan-port-config
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this wan-port-config by id
Store the name of this wan-port-config.
Store the id of the device of this wan-port-config.
Store the id of the vlan of this wan-port-config.
Store the ip-address of this wan-port-config.
Store the ipv4-address of this wan-port-config.
Store the ipv6-address of this wan-port-config.
Store the provider-ip-address of this wan-port-config.
Store the provider-ipv4-address of this wan-port-config.
Store the provider-ipv6-address of this wan-port-config.
Store the input-bandwidth of this wan-port-config.
Store the output-bandwidth of this wan-port-config.
Store the description of this wan-port-config.
Store the port-type of this wan-port-config.
Store the port-number of this wan-port-config.
Store the transport-network-name of this wan-port-config.
Store the device-port-id of this wan-port-config.
Store the wan-port-id of this wan-port-config.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Used for optimistic concurrency. Must be empty on create, valid on update and delete.
Collection of wan-port-configs
A zone is a grouping of assets in a location homing to the same connections into the CBB
A local autonomous-system is located in a zone.(1)
The contact supports a zone.
The network-range is located in a zone
A fabric subnet belongs to a zone.(1)
Code assigned by AIC to the zone
English name associated with the zone
The type of zone (ex. AIC or NC).
Design of zone [Medium/Large]
Context of zone [production/test]
Status of a zone.
Role of a zone.
Function of a zone.
Concurrency value
Used to indicate whether or not zone object is in maintenance mode.
Collection of zones
describes an activities
The activity applies to a cloud-region.(4)
The reservation information associated with a NAT Pool mapping.
An activity is being performed on a network-range.(4)
The activity applies to a p-interface.(4)
The activity applies to a pnf.(4)
The activity applies to a pserver.(4)
An activity-state is tracks the state of an activity.(1)
Unique id for the activity. (UUID)
Type of activity (ex, provisioning).
Name of the activity.
Application that created the activity.
Description of activity.
Date and Time activity is created.
Current state of the activity.
State reflected by the database.
Role
Function
Date/time last updated
Date/time expires
describes an activities
An activity-state is tracks the state of an activity.(4)
Order for the activity state.
Name of the activity state (ex, NVT-PROV).
View of the activity state.
Definition of address family
Address Family belongs to a bgp-group(4)
Address Family belongs to a bgp-neighbor(4)
A policy applies to an address family.
address family UUID.
address family type (aka afi)
address family subtype (aka safi)
role of address-family
function of address-family
Aggregate route configs are used on the D2 IPEs for the Voice services. In 1902, SDNC will create aggregate-route objects and write them to A&AI.
An aggregate-route BelongsTo a vrf.(4)
A vpn-binding uses many aggregate routes
Route UUID.
Name of the forwarding-path
CIDR-mask for aggregate route subnet
Identifies is aggregate route is ipv4 or ipv6
Represents a slice or partial piece of a resource that gets separately allotted
AAI-1925
AAI-1925 For CCVPN Usecase
AAI-1925
For CCVPN Usecase
Allotted Resource id UUID assigned to this instance.
The descriptive information assigned to this allotted resource instance
Link back to more information in the controller
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Orchestration status
Indicator for whether the resource is considered operational
Generic description of the type of allotted resource.
role in the network that this resource will be providing.
Store the name of this allotted-resource.
Store the id of the access provider of this allotted-resource.
Store the id of the access client of this allotted-resource.
Store the id of the access topology of this allotted-resource.
Store the id of the access node of this allotted-resource.
Store the id of the access ltp of this allotted-resource.
Store the cvlan of this allotted-resource.
Store the vpn-name of this allotted-resource.
Description of Autonomous System
A local autonomous-system is located in a zone.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor is a member of an autonomous-system.
pnf is located in the autonomous-system.
UUID
asn in the range of 0 to 9223372036854775807
type (global vs. local).
geographic region
role of autonomous system
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.
Instance of an available-bandwidth-map
For MDONS usecase(4)
Id that identifies the attribute
ODU Type that identifies the ODU Eg. ODU0, ODU1, ODU2, ODU3, ODU4
The value of available bandwidth. Applicable only for ENNI.
Store the link to get more information for this object.
Instance of a bandwidth-attribute
For MDONS usecase(4)
For MDONS usecase(1)
Id that identifies the bandwidth attribute
Store the link to get more information for this object.
BFD (Bidirectional Forwarding Detection) is a protocol for detecting link failures.The BFD object is for persisting attributes for the links that have BFD enabled.
Unique identifier.
Used to categorize this object in conjunction with role & function. The most generic category.
Used to categorize this object in conjunction with type & function.
Used to categorize this object in conjunction with type & role. The most specific category.
bfd keep-alive parameter
bfd timeout parameter
Definition of bgp-group
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
A bgp-group belongs to a pnf.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
A bgp-group belongs to a pnf.(4)
Address Family belongs to a bgp-group(1)
bgp-neighbor is a member of an bgp-group.
The bgp-group associated to a generic-vnf.(3)
A policy applies to a bgp-group.
UUID.
name of bgp-group
type of bgp-group
role of bgp-group
function of bgp-group
local a-s number type of vrf (bridge-domain as an example)
local address
peer a-s number
peer address
description of bgp-group
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Definition of bgp-neighbor
bgp-neighbor is a member of an autonomous-system.
bgp-neighbor is a member of an bgp-group.
bgp-neighbor uses To node-type.
bgp-neighbor uses To node-type.
A policy applies to a bgp-neighbor.
A bgp-neighbor belongs to a pnf.(4)
bgp-neighbor belongs To a subnet.(4)
bgp-neighbor uses To node-type.
bgp-neighbor uses To node-type.
A bgp-neighbor belongs to a vrf.(4)
Address Family belongs to a bgp-neighbor(1)
The configuration Uses bgp-neighbor.
The bgp-neighbor associated to a generic-vnf.(3)
A policy applies to a bgp-neighbor.
UUID.
name of bgp-group
type of bgp-group
role of bgp-group
local a-s number type of vrf (bridge-domain as an example)
local address
peer a-s number
peer address
description of bgp-group
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
provisioning status. Valid values can be found at (https://wiki.web.att.com/display/SPTIIRP/prov-status).
hostname of the peer
Definition of cable
A cable is located in a complex.(4)
The cable is this item from the hardware-catalog.
A cable is composed of one or more physical-links.
A pluggable that is intergrated with a cable.(1)
A channel-interface terminates a channel-link.
A unique name for the channel-link relative to the physical-link.
The type of cable.
Definition of card
A card is located in a card-slot.(4)
The card is described by the hardware-catalog-item.
A pluggable slot is located in a card.(1)
A port is located in a card.(1)
The profile (set of characteristics) applies to the card.
The type of card.
Definition of card-slot
A card-slot is located in a chassis.(4)
A card is located in a card-slot.(1)
The name of the card-slot (unique relative to the chassis).
Definition of chassis
A chassis LinksTo a complex.
The chassis is described by the hardware-catalog-item.
A chassis is part of a pnf.
A chassis is part of a pserver.
A chassis is LocatedIn a rack.
A chassis uses space in a rack (aka one or more rack-units).
A card-slot is located in a chassis.(1)
A license belongs to a chassis.(1)
A pluggable-slot is located in a chassis.(1)
A port is LocatedIn a chassis.(1)
The profile (set of characteristics) applies to the chassis.
A globally unique name for the chassis.
The type of chassis..
The role of the chassis relative to the pnf/pserver..
Operating system of the hardware.
The serial number of the chassis..
The asset tag of the chassis.
Description of the chassis.
Part number for this chassis.
Orchestration status of this chassis.
Equipment model.
Equipment vendor. Source of truth should define valid values.
CLEI or other specification for chassis hardware.
Slot number associated with this chassis.
Reflects the admin-state of the device.
unique identifier of probe
identifier of probe
type of probe
cloud-region designates an installation of a cloud cluster or region or instantiation. In AT&Ts AIC cloud, this could be an LCP or DCP. Cloud regions are uniquely identified by a composite key, cloud-owner + cloud-region-id. The format of the cloud-owner is vendor-cloudname and we will use att-aic for AT&T's AIC.
The cloud-region associated to a geo-region
a cloud-region implements policies
The cloud-region is part of a project (ex, project that built out the cloud region).
The activity applies to a cloud-region.(1)
The contact supports a cloud-region.
The mapping associated to a cloud-region
The network-range is located in a cloud-region
A pnf is located in (aka supports) a cloud-region.
used for CSP pnf to cloud-region.
The validation-audit associated to a cloud-region(1)
A vlan range belongs to a cloud-region.(1)
Identifies the vendor and cloud name. First part of composite key should be formatted as vendor-cloudname
Identifier used by the vendor for the region. Second part of composite key
Type of the cloud (e.g., openstack)
Cloud-owner defined type indicator (e.g., dcp, lcp)
Software version employed at the site. NOTE - THIS FIELD IS NOT KEPT UP TO DATE.
URL of the keystone identity service
Zone where the cloud is homed. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
complex name for cloud-region instance. NOTE - THIS FIELD IS NOT CORRECTLY POPULATED.
Whether the cloud region supports (true) or does not support (false) SR-IOV automation.
ESR inputs extra information about the VIM or Cloud which will be decoded by MultiVIM.
Number that maps to the letter at the end of the cloud-region-id.
Function of cloud-region.
Role of cloud-region.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The alias used for this cloud.
Status of cloud-region.
Upgrade cycle for the cloud region. For AIC regions upgrade cycle is designated by A,B,C etc.
Used to indicate whether orchestration is enabled for this cloud-region.
Used to indicate whether or not cloud-region object is in maintenance mode.
represents the collection resource in the TOSCA model
Collection Object UUID
ASDC model id for this resource or service model
Model Version
collection name
Collection type
Collection Role
Collection function
orchestration status
Captures the id of all the configuration used to customize the resource for the service
Requirement of comunication service.
ID of the profile.
The maximum number of UEs may simultaneously access the communication service
A list of TrackingAreas where the NSI can be selected.
The packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance.
User experience data rate of upload.
User experience data rate of download.
User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.
Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).
Collection of physical locations that can house cloud-regions.
The complex associated to a geo-region
A cable is located in a complex.(1)
A chassis LinksTo a complex.
The contact supports a complex.
The network-range is located in a complex
A rack is located in a complex (aka building).(1)
For CCVPN Usecase
Unique identifier for physical location, e.g., CLLI
Data center code which can be an alternate way to identify a complex
Gamma complex name for LCP instance.
URL of the keystone identity service
Type, e.g., central office, data center.
The time zone where the complex is located.
Generic configuration object.
The configuration Uses bgp-neighbor.
Relates configuration to network-route for static routes.
A configuration uses a policy
A configuration uses a subnet
A Configuration uses VRFs
UUID assigned to configuration.
Indicates the entity that will manage this feature. Could be an organization or the name of the application as well.
Name of the configuration.
port-mirroring-configuration.
vprobe, pprobe.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Orchestration status of the configuration.
Indicator for whether the resource is considered operational.
URL to endpoint where AAI can get more details from SDN-GC.
id of the configuration used to customize the resource
DHV Site Effective Bandwidth
Velocloud Nominal Throughput - VNT
Used to capture the name of the fabric configuration policy that was used to generate the payload sent to PINC for fabric configuration.
Used to categorize the configuration.
Used to categorize the configuration.
Used by some configurations to identify if it's filling a primary role.
Used to categorize the configuration.
Instance of a connectivity
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this connectivity by id
Store the name of a bandwidth profile.
Store the type of a bandwidth profile.
Store the CIR of this connectivity.
Store the EIR of this connectivity.
Store the CBS of this connectivity.
Store the EBS of this connectivity.
Store the color-awareness of this connectivity.
Store the coupling flag of this connectivity.
The ethernet service name for this connectivity.
Store the id of the access provider of this connectivity.
Store the id of the access client of this connectivity.
Store the id of the access topology of this connectivity.
Store the id of the access node of this connectivity.
Store the id of the access ltp of this connectivity.
Store the link to get more information for this connectivity.
Store the cvlan for this connectivity.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Collection of resource instances used to connect a variety of disparate inventory widgets
Unique id of resource 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.
This is how we would capture constraints defining allowed sets of elements.
Contacts store the vendor information and have a relationship to the generic-vnf. In 1902, this will be populated by SDN-GC
The contact supports a cloud-region.
The contact supports a complex.
The contact supports a pnf.
The contact supports a pserver.
The contact supports a zone.
Name of the contact
Tel no. of contact
e-mail of contact
NI (Network Integrator)SI (System Integrator) 3rd Party LCM
| SE group | This object captures the point of attachment from services or resources to a virtual link or network. | A&AI clients for this object are typically: DCAE-DTI, (DMaaP-DCAE,...) |
AAI-2154 For BBS Usecase
cp is child of vnfc(3)
Unique ID of the connection point.
port index to represent multiple CPs on VNFC connected to same network.
id.
A collection of C tags (vlan tags) grouped for a specific purpose.
The Target provider edge router
Name of the availability zone
Describes what the intended purpose of this pool is.
Comma separated list of ctags
customer identifiers to provide linkage back to BSS information.
service-subscription BelongsTo customer(1)
Global customer id used across ONAP 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.
See mis-na-virtualization-platform.yang
Instance of a device
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this device by id
Store the esn of this device.
Store the name of this device.
Store the description of this device.
Store the vendor of this device.
Store the class of this device.
Store the type of this device.
Store the version of this device.
Store the system-ip of this device.
Store the system-ipv4 of this device.
Store the system-ipv6 of this device.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Instance of a dhcp-service
For CCVPN Usecase(3)
Uniquely identifies this dhcp-service by id
Store the server-ip4-address of this dhcp-service.
Store the server-ipv6-address of this dhcp-service.
Store the service-enable of this dhcp-service.
Store the dhcp-service-type of this dhcp-service.
Store the lease-time of this dhcp-service.
Store the domain-name of this dhcp-service.
Store the dns of this dhcp-service.
Store the ntp-primary of this dhcp-service.
Store the ntp-secondary of this dhcp-service.
Store the nbns of this dhcp-service.
Digital virtual switch metadata, used by SDN-C to configure VCEs. A&AI needs to receive this data from the PO deployment team and administer it using the provisioningTool.sh into A&AI.
DVS switch name
URL used to reach the vcenter
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.
Metadata for entitlement group.
Unique ID for the entitlement group the resource comes from, should be uuid.
Unique ID of an entitlement resource.
Persist EMS address information used by EMS driver.
Unique ID of EMS.
Persist NFVO address information used by VF-C.
Unique ID of nfvo.
indecate the api-root.
Persist common address information of external systems.
For CCVPN Usecase(3)
Unique ID of esr system info.
name of external system.
type of external systems.
vendor of external systems.
version of external systems.
url used to access external systems.
username used to access external systems.
password used to access external systems.
it could be vim/vnfm/thirdparty-sdnc/ems-resource/ems-performance/ems-alarm.
protocol of third party SDNC, for example netconf/snmp.
ca file content if enabled ssl on auth-url.
Whether to verify VIM's certificate.
service IP of ftp server.
service port of ftp server.
domain info for authentication.
default tenant of VIM.
ftp passive mode or not.
resource or performance data file path.
the status of external system.
OpenStack region ID used by MultiCloud plugin to interact with an OpenStack instance.
Persist SDNC address information used by ONAP SDNC.
For MDONS Usecase(2)
Unique ID of SDNC.
used for DC type to indicate the location of SDNC, such as Core or Edge.
password used to access SDNC server.
Domain type of the SDNC controllerr.
Persist VNFM address information used by VF-C.
Unique ID of VNFM.
indecate the VIM to deploy VNF.
certificate url of VNFM.
evc object is an optional child object of the Configuration object.
Unique/key field for the evc object
Point-to-Point, Multi-Point
Commited Information Rate
CIR units
Diversity Group ID
formerly Performance Group
EVC Circuit ID of ESP EVC
Committed Information Rate (For ESP)
CIR units (For ESP)
Identifies ESP
Collector POP CLLI (from the hostname of the access pnf)
Interconnect type on ingress side of EVC.
tagode for collector side of EVC
tagMode for network side of EVC
Product ID
Refer to an external AAI in another ONAP.
For CCVPN Usecase(2)
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Unique ID of the referenced AAI.
Schema version of the referenced AAI.
Openstack flavor.
HPA Capacity getting the compute nodes from given 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
Entity describing a sequenced segment of forwarding path
Points to the generic-vnf(s) involved in this forwarding step.
Unique ID of this segmentation
ingress, intermediate, egress
forwarder object is an optional child object of the Configuration object.
Key for forwarder-evc object
Circuit ID from customer/ESP/ingress end of EVC, or reference to beater circuit on gateway/network/egress end of EVC
Internal VLAN.
SVLAN value for ingress of egress forwarder.
CVLAN value for ingress of egress forwarder.
Entity that describes the sequenced forwarding path between interfaces of services or resources
Unique ID of this FP
Name of the FP
the self link for this FP
A fully qualified domain name (FQDN) is the complete domain name for a specific computer, or host, on the internet.
The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).
The fqdn that applies to a generic-vnf.
The fqdn that applies to a l3-interface-ipv4-address-list.
The fqdn that applies to a l3-interface-ipv6-address-list.
The fqdn that applies to a vip-ipv4-address-list.
The fqdn that applies to a vip-ipv6-address-list.
The dns cname record that applies to an A-record (ipv4) and/or quad-A-record (ipv6).
Fully qualified domain name.
Used to categorize this object in conjunction with role & function. The most generic category.
Used to categorize this object in conjunction with type & function.
Used to categorize this object in conjunction with type & role. The most specific category.
Domain name.
General purpose VNF
The bgp-group associated to a generic-vnf.(2)
The bgp-neighbor associated to a generic-vnf.(2)
For CCVPN Usecase
For CCVPN Usecase
Points to the generic-vnf(s) involved in this forwarding step.
The fqdn that applies to a generic-vnf.
For CCVPN Usecase
AAI-2154 For BBS Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Unique id of VNF. This is unique across the graph.
vnf instance id.
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 in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
Unique identifier of service, does not necessarily map to ASDC service models. SOON TO BE DEPRECATED
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. Valid values are in-service-path and out-of-service-path.
OBSOLETE - do not use
Client should send valid enumerated value
Orchestration status of this VNF, used by MSO.
vnf discriptor name
job id corresponding to vnf
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 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, to be used only by uCPE
units associated with vcpu, used for VNFs with no vservers/flavors, to be used only by uCPE
number of GB of memory ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only by uCPE
units associated with vmemory, used for VNFs with no vservers/flavors, to be used only by uCPE
number of vdisks ordered for this instance of VNF, used for VNFs with no vservers/flavors, to be used only uCPE
units associated with vdisk, used for VNFs with no vservers/flavors, to be used only by uCPE
number of associated SHD in vnf.
number of vms in vnf.
number of network in vnf.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
used to indicate whether closed loop function is enabled on this node
details regarding the generic-vnf operation, PLEASE DISCONTINUE USE OF THIS FIELD.
indicates whether generic-vnf access uses SSH
UUID of the Entitlement group used for licensing VNFs, OBSOLETE - See child relationships.
UUID of the specific entitlement resource. OBSOLETE - See child relationships.
UUID of the license assignment group. OBSOLETE - See child relationships.
UUID of the actual license resource. OBSOLETE - See child relationships.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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
Generic description of the type of NF
English description of Network function that the specific VNF deployment is providing
role in the network that this model will be providing
string assigned to this model used for naming purposes
Path to the controller object.
Gateway address
Prefix length for oam-address
Temporary location for S-TAG to get to VCE
Network Management profile of this VNF
VNF instance specific software version
vnf application-id
Top level node for a cg-nat geographical region.
The cloud-region associated to a geo-region
The complex associated to a geo-region
The lag-interface associated to a geo-region
UUID, key for geo-region object.
Name of geo-region
Type of geo-region
Role of geo-region
Function of geo-region
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
describes an hardware-catalog-items
The cable is this item from the hardware-catalog.
The card is described by the hardware-catalog-item.
The chassis is described by the hardware-catalog-item.
The pdu is described by the hardware-catalog-item.
The pluggable is described by the hardware-catalog-item.
A set of characteristics of the hardware-catalog-item.
The rack is this item from the hardware-catalog.
Unique name for the hardware-catalog-item
Type of system defined by ATT
Manufacturer of the hardware-catalog-item (ex,Cisco)
Model of the hardware-catalog-item (ex,5501 NCS)
Part number assigned by the manufacturer
Description of the hardware-catalog-item
Stock-keeping-unit (ATT specific identifier for the hardware-catalog-item)
describes an hostAggregates
Unique identifier for the host-aggregate.
Name of the host-aggregate.
host-route id
subnet prefix
Could be ip-address, hostname, or service-instance
Should be ip-address, hostname, or service-instance to match next-hop
Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.
Represents a HPA capability
UUID to uniquely identify a HPA capability
Name of the HPACapability
HPA schema version
Hardware architecture
HPA Capacity information for compute node
HPA Capacity KV for given compute node(4)
Composite key formed with hpaFeature and append list of hpaFeatureAttributes needed for capacity check
JSON string specifying the capacity (total,free), unit and metadata of the specific HPA attribute
HPA Capability Feature attributes
name of the specific HPA attribute
JSON string specifying the value, unit and type of the specific HPA attribute
create/update/delete the hw-component node
The profile associated to a hw-component
The hw-component associated to a pnf
The hw-component associated to a pserver
UUID
Name of hardware component
Type of hardware component
Role of hardware component
Function of hardware component
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
General mechanism for grouping instances
The instance-group associated to an instance-group
The instance-group associated to an instance-group
The mapping associated to an instance-group
The policy associated to an instance-group
A profile (set of characteristics) applies to the instance-group (as a vrrp group).
The rack is a member of the instance-group (rack-group or pod).
MSO creates this edge on VNF Group Service creation
Instance Group ID, UUID assigned to this instance.
role of the instance group.
ASDC model id for this resource or service model.
ASDC model version uid for this resource model.
Descriptive text to help identify the usage of this instance-group
Only valid value today is lower case ha for high availability
Instance-Group Name.
Instance-Group Function
Number used to identify an instance-group
Used to identify the primary and secondary priority
Instance of an inter layer topology attachment
For CCVPN Usecase(1)
For CCVPN Usecase(1)
Id that identifies the interlayer topology attachment
Inter layer lock id
Store the link to get more information for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
IPSec configuration node will contain various configuration data for the NMTE VNF. This node will have an edge to the generic-vnf (vnf type = TE). Starting 1607, this data will be populated by SDN-C
UUID of this configuration
Indicate the type of VIG server like AVPN, INTERNET, BOTH
Encryption values like 3des-cbc, des-cbc, aes-128-cbc, aes-192-cbc, aes-265-cbc
Shared DMZ or a DMZ specific to a customer
Network address of shared DMZ
If the DMZ is a custom DMZ, this field will indicate the customer information
can be 1 or 2
Contains values like md5, sha1, sha256, sha384
Encyption values like 3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc
Diffie-Hellman group like DH-GROUP2, DH-GROUP5, DH-GROUP14
Group name defined in VIG for clients using aggressive mode
pre-shared key for the above group name
Lifetime for IKEv1 SA
md5, sha1, sha256, sha384
3des-cbc, des-cbc, aes-128-cbc,aes-192-cbc, aes-265-cbc
Life time for IPSec SA
enable PFS or not
user ID for xAuth, sm-user,ucpeHostName,nmteHostName
Encrypted using the Juniper $9$ algorithm
The time between DPD probe
Maximum number of DPD before claiming the tunnel is down
Logical interfaces, e.g., a vnic.
The l-interface that is used by the next-hop.
A logical interface associated with a pnf.(4)
A logical interface associated with a pserver.(4)
An sub-interface that uses a vlan-tag.
The policy applies to an l-interface.
A profile (set of characteristics) applies to the l-interface.
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
Human friendly text regarding this interface.
type to sub-classify the l-interface (ex, loopback)
boolean indicatating whether or not port is a mirrored.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
Prov Status of the logical interface. Valid values [PREPROV/NVTPROV/PROV].
Flag indicating the interface uses the IP Unnumbered configuration.
Freeform field for storing an ip address, list of ip addresses or a subnet block.
Priority used for fail-over. Valid values 1-1024, with 1 being the highest priority.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this Linterface
Identifies l2-multicasting support on an l-interface. true indicates that l2-multicasting is supported; defaulted to false .
Administrative status of the interface. Valid values are 'up', 'down', or 'testing'.
IPv4 Address Range
A IPv4 address associated with a lag-interface.(4)
A IPv4 address associated with a p-interface.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a l3-interface-ipv4-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the l3-interface-ipv4-address-list of an R-Leaf's l-interface that is for VLAN 2
IP address
Prefix length, 32 for single address
Inner VLAN tag
Outer VLAN tag
Indicator of fixed or floating address
Neutron network id of the interface that address belongs to
Neutron id of subnet that address belongs to
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
IPv6 Address Range
A IPv6 address associated with a lag-interface.(4)
A IPv6 address associated with a p-interface.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a l3-interface-ipv6-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the l3-interface-ipv6-address-list of an R-Leaf's l-interface that is for VLAN 2
IP address
Prefix length, 128 for single address
Inner VLAN tag
Outer VLAN tag
Indicator of fixed or floating address
Neutron network id of the interface that address belongs to
Neutron id of subnet that address belongs to
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Generic network definition
l3-network uses l3-network
Relates l3-network to network-route for static routes.
A l3-network Uses vlan-tag.
l3-network uses l3-network
A policy applies to l3-networks.
A profile (set of characteristics) applies to the l3-network.
A vrf uses many l3-networks
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?
text used for documentation
Neutron network id of this Interface
Set to true if bound to VPN
Unique identifier of service from ASDC. Does not strictly map to ASDC services. SOON TO BE DEPRECATED
network role instance
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Contrail FQDN for the network
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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.
boolean indicatating whether or not network is a provider network.
boolean indicatating whether or not network is a shared network.
boolean indicatating whether or not network is an external network.
Path to the controller object.
Indicator for whether the resource is considered operational.
Trunked network indication.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this l3 network
Instance of an label restriction
For CCVPN Usecase(4)
Id that identifies the label restriction
First number in the label range
Last number in the label range
Bitmap of available labels starting from label-start to label-end.
Step of labels in label range.
Indicate wheather range-bitmap items are inclusive or exclusive.
Indicate the label range e.g.trib-slot, trib-port
Indicate trib slot granularity.
Priority.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Link aggregate interface
The lag-interface associated to a geo-region
A IPv4 address associated with a lag-interface.(1)
A IPv6 address associated with a lag-interface.(1)
A profile (set of characteristics) applies to the lag-interface.
Name that identifies the link aggregate interface
Human friendly text regarding this interface.
Captures the numeric part of the speed
Captures the units corresponding to the speed
ID of interface
Role assigned to this Interface, should use values as defined in ONAP Yang models.
Trigger for operational monitoring of this resource by Service Assurance systems.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
The system id used by the LACP protocol.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this Lag interface
Minimum links in service before a LAG should be taken out of service
LAG links can connect lag-interfaces
Alphabetical concatenation of lag-interface names
Instance of a lan-port-config
For CCVPN Usecase(2)
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this lan-port-config by id
Store the name of this lan-port-config.
Store the description of this lan-port-config.
Store the device-id of this lan-port-config.
Store the port-id of this lan-port-config.
Store the ipv4-address of this lan-port-config.
Store the ipv6-address of this lan-port-config.
Store the vlan-tag of this lan-port-config.
Store the input-bandwidth of this lan-port-config.
Store the output-bandwidth of this lan-port-config.
Metadata for license group.
A license belongs to a chassis.(4)
Unique ID for the license group the resource belongs to, should be uuid.
Unique ID of a license resource.
Used to store CFAS or other project numbers.
Order number.
Date of receipt.
describes a line-of-business
A line-of uses a vlan-range
The line-of-business associated to a validation-audit
Name of the line-of-business (product)
Logical links generally connect l-interfaces but are used to express logical connectivity between two points
For CCVPN Usecase
The port associated with a logical-link(2)
For CCVPN Usecase(4)
A policy applies to a bgp-neighbor.
A profile (set of characteristics) applies to the logical-link.
e.g., evc-name, or vnf-nameA_interface-nameA_vnf-nameZ_interface-nameZ
used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
Type of logical link, e.g., evc
Captures the numeric part of the speed
Captures the units corresponding to the speed
Captures the units corresponding to the speed
Captures the administrative state of the link
v4, v6, or ds for dual stack
For example, static or BGP
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.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
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.
Circuit id
Reason for this entity, role it is playing
A description for the logical-link.
A segment-id assigned to the logical-link (ex, esi for ethernet segments).
The function performed by this logical link
General mechanism for mapping between instances; cg-nat.
The mapping associated to a cloud-region
The mapping associated to an instance-group
The mapping associated to a mapping
The mapping associated to a mapping
The mapping associated to a pnf
The mapping associated to a policy
The reservation information associated with a NAT Pool mapping.
The mapping associated to a mapping
The mapping associated to a mapping
Key for mapping object.
Name of mapping
Type of mapping.
Role of mapping
Function of mapping
Number of mapping
Location 1
Location 2
Non-unique ID for grouping mappings
Provision status for the mapping object. Valid values can be found at (https://wiki.web.att.com/display/SPTIIRP/prov-status).
Location the object is homed to
Location the object is planned for
Key/value pairs
AAI-2154 For BBS Usecase
AAI-2154 For BBS Usecase
AAI-2154 For BBS Usecase
Subgraph definition provided by ASDC to describe an inventory asset and its connections related to ASDC models, independent of version
Unique identifier corresponding to the main definition of a model in ASDC
Type of the model, e.g., service, resource, widget, etc.
Role of the model,e.g.,NST,NSST,CST,etc
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
Subgraph definition provided by ASDC to describe a specific version of an inventory asset and its connections related to ASDC models
Unique identifier corresponding to one version of a model in ASDC
Name of the model, which can change from version to version.
Version
Distribution Status
Description
The CDS blue print name associated with the resource.
The version of the CDS blue print.
Unique id of multicast configuration.
protocol of multicast configuration
rp type of multicast configuration
TBD
TBD
UUID representing unique key to this instance
Contrail FQDN for the policy
ID for the openStack Heat instance
Name of the policy
Type of the policy
The packet transmission latency (millisecond) through the Transport slice connections and is used to evaluate utilization performance of the end-to-end network slice instance.
jitter
The maximum bandwidth (mb) of the connection links in a transport slice instance.
Network profile populated by SDN-GP for SNMP
Unique name of network profile.
Encrypted SNMP community string
Description of Network Range
The network-range is located in a cloud-region
The network-range is located in a complex
The network-range is located in a zone
An activity is being performed on a network-range.(1)
UUID
name
type (ex, esi, vni, vni-rt, lacp-id).
role of network-range
descriptive function
starting range for simple network ranges.
end range for simple network ranges.
last assigned value for simple network ranges
Format Decimal, Hexadecimal, etc.
Prefix of network range.
Instance of a network-resource
For CCVPN Usecase
For CCVPN Usecase
For MDONS Usecase(3)
For CCVPN Usecase(1)
Uniquely identifies this network-resource by id
Store the id of the provider of this network-resource.
Store the id of the client of this network-resource.
Store the id of the te-topo of this network-resource.
Type of a network topology, e.g., Ethernet, OTN, WSON.
Store the link to get more information for this object.
This object represents a network route. For instance, host-route, static-route.
The network-route that is used by the next-hop.
The route is part of part of a subnet.
Relates configuration to network-route for static routes.
Relates l3-network to network-route for static routes.
Relates vrf to network-route for static routes.
unique identifier example uuid.
used to categorize this object in conjunction with role & function. The most generic category.
used to categorize this object in conjunction with type & function.
used to categorize this object in conjunction with type & role. The most specific category.
ip address that of the specific network-route.
ip-address prefix length.
Identity of a logical interface, e.g., VLAN ID.
Could be ip-address, hostname, or service-instance.
Should be ip-address, hostname, or service-instance to match next-hop.
Value that is assigned to an IP route for a particular network interface that identifies the cost that is associated with using that route.
whether the route address is ipv4, ipv6.
The network-technology object is used to capture the supported network technologies of a cloud-region.
Unique identifier of the network-technology object (UUID)
The network-technology that a cloud-region can support. Current valid values- CONTRAIL AIC_SR_IOV OVS STANDARD-SR-IOV
This object fills in the gaps from vce that were incorporated into generic-vnf. This object will be retired with vce.
Unique id of VNF, can't use same attribute name right now until we promote this new object
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the ASDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ECOMP matures.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
Indicator for whether the resource is considered operational
OBSOLETE - do not use
Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
Client should send valid enumerated value.
v4 Loopback0 address
Orchestration status of this VNF, mastered by MSO.
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Is among the series of routers that are connected together in a network and is the next possible destination for a data packet.
The l-interface that is used by the next-hop.
The network-route that is used by the next-hop.
The rule that is used by the next-hop. For CG-NAT these are the ACL policies.
The vrfs that are used by the next-hop.
UUID.
Used to categorize this object in conjunction with role & function. The most generic category.
Used to categorize this object in conjunction with type & function.
Used to categorize this object in conjunction with type & role. The most specific category.
Sequence number.
Ipv4 or Ipv6.
Next hop ip-address.
Cost that is associated with using the route.
nos-server is the execution environment that will have images, certain versions of VNOS, running on it.
Unique identifier for this nos relative to its tenant
Name of nos
uCPE vendor
Trigger for operational monitoring of this resource by Service Assurance systems.
URL to endpoint where AAI can get more details
Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
OAM network, to be deprecated shortly. Do not use for new purposes.
UUID of the network. Unique across a cloud-region
Name of the network.
cvlan-id
Used for VNF firewall rule so customer cannot send customer traffic over this oam network
Used for VNF firewall rule so customer cannot send customer traffic over this oam network
It is a logical partition of the cloud which allows to have multiple environments in the production AIC.
UUID of an operational environment
Operational Environment name
Operational Environment Type.
Status
Tenant Context.
Workload Context.
Allows for legacy POST of old-style and new-style models
Unique identifier corresponding to the main definition of a model in ASDC
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
describes an owning-entity
An owning-entity uses a vlan-range.
service-instance Uses an owning-entity
UUID of an owning entity
Owning entity name
Physical interface (e.g., nic)
For CCVPN Usecase(4)
For CCVPN Usecase(4)
The activity applies to a p-interface.(1)
AAI-1925 For CCVPN Usecase
For MDONS usecase(1)
A IPv4 address associated with a p-interface.(1)
A IPv6 address associated with a p-interface.(1)
A port is composed of one or more p-interfaces.(3)
A profile (set of characteristics) applies to the p-interface.
For MDONS Use case
For CCVPN Usecase
For CCVPN Usecase
Name that identifies the physical interface
Alternate name that identifies the physical interface
URL to endpoint where AAI can get more details.
Captures the numeric part of the speed
Captures the units corresponding to the speed
Nature of the services and connectivity on this port.
Domain type of the SDNC controllerr.
CLEI or other specification for p-interface hardware.
Role specification for p-interface hardware.
Indicates the physical properties of the interface.
Indicates the physical properties of the interface.
Trigger for operational monitoring of this resource by Service Assurance systems.
MAC Address of the p-interface.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
inventory status
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
The function performed by this pInterface
MAC address for the interface
Store the network-ref of this p-interface. Derived from ietf-restconf-notification that identifies a termination-point.
Store the transparent value of this p-interface.
oper Status of this p-interface.
connect interdomain link
Definition of pdu
The pdu is described by the hardware-catalog-item.
A pdu is located in a building (aka complex).(4)
A pdu uses space in a rack (aka one or more rack-units).
The profile (set of characteristics) applies to the pdu.
A unique name for the power distribution unit.
The type of pdu.
Collection of physical connections, typically between p-interfaces
A cable is composed of one or more physical-links.
A profile (set of characteristics) applies to the physical-link.
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.
Upstream Bandwidth value agreed with the service provider
Units for the upstream BW value
Downstream Bandwidth value agreed with the service provider
Units for downstream BW value
The function performed by this physical link
Indicator for the use of this physical link
Subtype used to categorize this physical link
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
describes a platform
Name of the platform
Definition of pluggable
A pluggable that is intergrated with a cable.(4)
The pluggable is described by the hardware-catalog-item.
A pluggable is located in a pluggable-slot.(4)
A port is located in a pluggable.(1)
The profile (set of characteristics) applies to the pluggable.
The type of pluggable.
Part number for this pluggable.
CLEI or other specification for pluggable hardware.
Definition of card-slot
A pluggable slot is located in a card.(4)
A pluggable-slot is located in a chassis.(4)
A pluggable is located in a pluggable-slot.(1)
The name of the pluggable-slot. (unique relative to the chassis or card).
PNF represents a physical network function. typically equipment used in the D1 world. in 1607, this will be populated by SDN-C to represent a premises router that a uCPE connects to. But this can be used to represent any physical device that is not an AIC node or uCPE.
pnf is located in the autonomous-system.
A pnf is located in (aka supports) a cloud-region.
used for CSP pnf to cloud-region.
For CCVPN Usecase
The hw-component associated to a pnf
For CCVPN Usecase(4)
A pnf uses policies
The pnf is part of a project (ex, VPMO that ordered the equipment).
The sw-component associated to a pnf
The activity applies to a pnf.(1)
A bgp-group belongs to a pnf.(1)
A bgp-neighbor belongs to a pnf.(1)
A chassis is part of a pnf.
The contact supports a pnf.
A logical interface associated with a pnf.(1)
The mapping associated to a pnf
AAI-2154 For BBS Usecase
A profile (set of characteristics) applies to the pnf.
For CCVPN Usecase(1)
A vrf belongs to a pnf.(1)
unique name of Physical Network Function.
name of Physical Network Function.
URL to endpoint where AAI can get more details.
source of name2
id of pnf
Naming code for network function
Network operating system used on the device.
The function performed by the 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 customer
Orchestration status of this pnf
ipv4-oam-address with new naming convention for IP addresses
sw-version is the version of SW for the hosted application on the PNF.
Used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
ID of the physical frame (relay rack) where pnf is installed.
Serial number of the device
IPV4 Loopback 0 address
IPV6 Loopback 0 address
IPV4 AIM address
IPV6 AIM address
IPV6 OAM address
CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
Nf Role is the role performed by this instance in the network.
admin Status of this PNF
Store the operational-status for this object.
Store the model-customization-id for this object.
The ASDC model id for this resource model.
The ASDC model version for this resource model.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Contains the value of the request id to the most recent configuration file/validation report for this PNF.
Status of latest configuration attempt represented by the config-url.
Subtype used to categorize this pnf
Indicates the PNF/R-Leaf was built with the VNF agnostic common base
11-character equipment CLLI.
This is the IP address (IPv4) for the PNF itself. This is the IPv4 address that the PNF iself can be accessed at.
This is the IP address (IPv6) for the PNF itself. This is the IPv6 address that the PNF iself can be accessed at.
Definition of policy
A policy applies to an address family.
A policy applies to a bgp-group.
A policy applies to a bgp-neighbor.
The policy associated to an instance-group
The policy applies to an l-interface.
A policy applies to l3-networks.
This edge allows for QOS policy to vlan-tag relationship. For a given policy get all vlan tags as well as for a given vlan-tag get all the policies.
A policy uses vpn-bindings
a cloud-region implements policies
A configuration uses a policy
An ip-address-list BelongsTo a policy.(1)
The mapping associated to a policy
A pnf uses policies
A profile (set of characteristics) applies to the policy.
Details relationships policy requires.
Unique Policy UUID.
Policy Name
Policy Type
Policy role
policy function
Do not track
Pre destination NAT
apply on forward
Host and Interface Type Selector
Order
Version
Status
Remote ASN
Namespace filter to apply the policy
Description of the policy
Set of rule variables
Definition of port
A channel-interface terminates a channel-link.
A port is located in a card.(4)
A port is LocatedIn a chassis.(4)
A port is composed of one or more p-interfaces.(2)
A port is located in a pluggable.(4)
A port LinksTo another port.
The port associated with a logical-link(3)
A port LinksTo another port.
A unique name for the port relative to the containing hardware.
The type of port.
The role of the port.
The numeric value for the speed of the port.
The units for the speed of the port.
Type of transceiver that creates this port.
clei-code or other similar identifier
part number
Port range start
Port range end
Used to capture the network interfaces of this VCE
Unique ID of the interface
Neutron network id of this Interface
Neutron network name of this Interface
Role assigned to this Interface, should use values as defined in ECOMP Yang models.
Unique ID for port group in vmware
Likely to duplicate value of neutron network name
DVS or standard switch name (should be non-null for port groups associated with DVS)
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Port List Range
Port number
Name or assignment for the port
Type or usage of the port
Operator to apply to the port (greater than, less than, etc).
describes an profiles
The profile (set of characteristics) applies to the card.
The profile (set of characteristics) applies to the chassis.
A set of characteristics of the hardware-catalog-item.
A profile (set of characteristics) applies to the instance-group (as a vrrp group).
A profile (set of characteristics) applies to the l-interface.
A profile (set of characteristics) applies to the l3-network.
A profile (set of characteristics) applies to the lag-interface.
A profile (set of characteristics) applies to the logical-link.
A profile (set of characteristics) applies to the p-interface.
The profile (set of characteristics) applies to the pdu.
A profile (set of characteristics) applies to the physical-link.
The profile (set of characteristics) applies to the pluggable.
A profile (set of characteristics) applies to the pnf.
A profile (set of characteristics) applies to the policy.
A profile (set of characteristics) applies to the pserver.
The profile (set of characteristics) applies to the rack.
A profile (set of characteristics) applies to the subnet.
A profile (set of characteristics) applies to the vlan-range.
A profile (set of characteristics) applies to the vlan-tag.
A profile (set of characteristics) applies to the vpn-binding.
A profile (set of characteristics) applies to the vrf.
The profile associated to a hw-component
Details relationships profile requires.
The profile associated to a sw-component
Name of the profile
Type of profile (ex,network-power-profile)
Set of characteristics of the profile.
Descriptive subtype.
used to categorize this object in conjunction with profile-type and profile-function.
used to categorize this object in conjunction with profile-type and profile-role. The most specific category
URL to endpoint where AAI can get more details
describes the project
The cloud-region is part of a project (ex, project that built out the cloud region).
The pnf is part of a project (ex, VPMO that ordered the equipment).
The pserver is part of a project (ex, VPMO that ordered the equipment).
Name of the project deploying a service
Type of project (ex, VPMO)
Current state of the project.
Description of the project.
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.
The hw-component associated to a pserver
The pserver is part of a project (ex, VPMO that ordered the equipment).
The sw-component associated to a pserver
The activity applies to a pserver.(1)
A chassis is part of a pserver.
The contact supports a pserver.
HPA Capacity getting the compute nodes from given flavor
HPA Capacity KV for given compute node(1)
A logical interface associated with a pserver.(1)
A profile (set of characteristics) applies to the pserver.
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
IPV4 Loopback 0 address
IPV6 Loopback 0 address
IPV4 AIM address
IPV6 AIM address
IPV6 OAM address
CANOPI's inventory status. Only set with values exactly as defined by CANOPI.
ID of Pserver
internet topology of Pserver
used to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
alternative pserver name
purpose of pserver
Prov Status of this device (not under canopi control) Valid values [PREPROV/NVTPROV/PROV]
Indicates who owns and or manages the device.
The host profile that defines the configuration of the pserver.
The role performed by the pserver.
The function performed by the pserver.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Definition of rack
A rack is located in a complex (aka building).(4)
The rack is this item from the hardware-catalog.
The rack is a member of the instance-group (rack-group or pod).
A chassis is LocatedIn a rack.
A pdu is located in a building (aka complex).(1)
The profile (set of characteristics) applies to the rack.
A rack-unit is located in a rack.(1)
A unique name for the rack (within the location).
The type of rack.
The location of the rack within the building.
The position of the rack (ex-floor-mounted).
Definition of rack-unit
A rack-unit is located in a rack.(4)
A chassis uses space in a rack (aka one or more rack-units).
A pdu uses space in a rack (aka one or more rack-units).
A unique name for the rack-unit (within the rack).
describes an relationship component
Defines the traversal needed to reach the node of relationship-rule(4)
NARAD object
Object property
Property value
Order in traversal
A keyword provided by A&AI to indicate an attribute.
Value of the attribute.
describes an relationship rule
Details relationships policy requires.
Details relationships profile requires.
Defines the traversal needed to reach the node of relationship-rule(1)
UUID.
Example global,site
Number of traversals
Node the related object applies to
Internal map to define some reserved properties of a vertex
The specific type of node in the A&AI graph
The URL to the specific resource
Openstack route table reference.
Route Table Reference id, UUID assigned to this instance.
FQDN entry in the route table.
Route target information
Number used to identify an RT, globally unique in the network
Role assigned to this route target
Unique id of routing instance
rpm owner
describes an rules
The rule that is used by the next-hop. For CG-NAT these are the ACL policies.
UUID.
ingress or egress
Positive protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.
Negative protocol match. tcp, udp, icmpv6, sctp, udplite, integer 1-255.
Action to perform when matching this rule.
Sequence number of the rule.
Threshold
status
Version
Named variable used for counting transactions.
Boolean to indicate whether or not logging is required.
Description.
Instance of an sdwan-vpn
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this sdwan-vpn by id
Store the name of this sdwan-vpn.
Store the vxlan-id of this sdwan-vpn.
Store the topology of this sdwan-vpn.
Store the tenant-id of this sdwan-vpn.
Store the vpn-id of this sdwan-vpn.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Openstack segmentation assignment.
Route Table Reference id, UUID assigned to this instance.
Selectors list
Selector
Name or assignment for the selector
Type or usage of the selector
Stand-in for service model definitions. Likely to be deprecated in favor of models from ASDC. Does not strictly map to ASDC services.
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
service version
Early definition of server/resource pairings, likely to be replaced by models. No new use should be made of this.
This gets defined by others to provide a unique ID for the service, we accept what is sent.
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures.
Instance of a service
MSO creates this edge on VNF Group Service creation
service-instance Uses an owning-entity
For MDONS Use case
This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this instance of a service
This field will store a name assigned to the service-instance.
String capturing type of service.
String capturing the service role.
Rate of the service instance.
Definition of the service layer.
Due date of the service creation.
End date of the service creation.
This field will store the environment context assigned to the service-instance.
This field will store the workload context assigned to the service-instance.
create time of Network Service.
last update of Network Service.
short description for service-instance.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC data dictionary widget model. This maps directly to the A&AI widget.
the ASDC data dictionary version of the widget model.This maps directly to the A&AI version of the widget.
Indicates the total bandwidth to be used for this service.
indicates the upstream bandwidth this service will use on the WAN1 port of the physical device.
indicates the downstream bandwidth this service will use on the WAN1 port of the physical device.
indicates the upstream bandwidth this service will use on the WAN2 port of the physical device.
indicates the downstream bandwidth this service will use on the WAN2 port of the physical device.
URL customers will use to access the vHN Portal.
An identifier that customers assign to the location where this service is being used.
Path to the controller object.
Orchestration status of this service.
String capturing request parameters from SO to pass to Closed Loop.
String capturing function of the service.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Requirement of E2E Slice service.
ID of the profile.
The packet transmission latency (millisecond) through the RAN, CN, and TN part of 5G network and is used to evaluate utilization performance of the end-to-end network slice instance.
The maximum number of UEs may simultaneously access the E2E slice service
A list of TrackingAreas where the NSI can be selected.
User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.
Whether the resources to be allocated to the network slice instance may be shared with another network slice instance(s).
Percentage value of the amount of simultaneous active UEs to the total number of UEs where active means the UEs are exchanging data with the network.
The jitter requirements of network slice.
An attribute specifies the time that an application consuming a communication service may continue without an anticipated message.
An attribute specifies in the context of network layer packet transmissions, percentage value of the amount of sent network layer packets successfully delivered to a given system entity within the time constraint required by the targeted service, divided by the total number of sent network layer packets.
This attribute defines achievable data rate of the network slice in downlink that is available ubiquitously across the coverage area of the slice.
This attribute defines downlink data rate supported by the network slice per UE.
This attribute defines achievable data rate of the network slice in uplink that is available ubiquitously across the coverage area of the slice.
This attribute defines uplink data rate supported by the network slice per UE.
This parameter specifies the maximum packet size supported by the network slice.
This parameter defines the maximum number of concurrent sessions supported by the network slice.
An attribute specifies the overall user density over the coverage area of the network slice.
Object that group service instances.
service-subscription BelongsTo customer(4)
Value defined by orchestration to identify this service across ONAP.
This property will be deleted from A&AI in the near future. Only stop gap solution.
unique identifier of probe
Prefix address
Prefix address
ip version, v4, v6
Hostname of the destination equipment to which SLAs are measured against.
The type of destinatination equipment. Could be Router, UCPE, etc.
Set of instances for probes used to measure service level agreements
Unique id of site pair set.
Instance of a site-resource
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this site-resource by id
Store the name of this site-resource.
Store the description of this site-resource.
Store the type of this site-resource.
Store the role of this site-resource.
Store the generated-site-id of this site-resource.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Requirement of network slice subnet service.
ID of the profile.
The packet transmission latency (millisecond) through the RAN or CN or TN and is used to evaluate utilization performance of the end-to-end network slice instance.
The maximum number of UEs may simultaneously access the slice subnet service
A list of TrackingAreas where the NSSI can be selected.
User mobility level, value can be stationary, nomadic, restricted mobility, fully mobility.
Whether the resources to be allocated to the slice subnet instance may be shared with another network slice instance(s).
User experience data rate of upload.
User experience data rate of download.
The area traffic capbility of upload.
The area traffic capbility of download.
An attribute specfies the percentage value of the amount of simultaneous active UEs to the total number of UEs where active means the UEs are exchanging data with the network.
The jitter requirements of network slice subnet.
Survival time for network slice subnet.
Maxmun bandwidth value of TN network.
Expected date rate for uRLLC.
maxNumberofPDUSession Integer 1 The maximum number of PDU sessions that can simultaneously/concurrently access to the network slice.
Overall User Density.
Communication service reliability mean time between failures.
Message size(byte) .
transferIntervalTarget String 1 Target value of transfer interval.
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).
Software Version
Identifier of the software version
used to indicate whether or not this software-version is the active one (activeSw = true)
Instance of an sp-partner
For CCVPN Usecase
Uniquely identifies this sp-partner by id
Store the URL of this sp-partner.
Store the callsource of this sp-partner.
Store the operational-status for this sp-partner.
Store the model-customization-id for this sp-partner.
the ASDC model id for this sp-partner model.
the ASDC model version for this sp-partner model.
SR-IOV Physical Function
Identifier for the sriov-pf
SR-IOV Virtual Function (not to be confused with virtual network function)
PCI ID used to identify the sriov-vf
This metadata provides option to specify list of VLAN filters applied on VF to pass the traffic to VM.
When MAC filters are specified, VF-agent service configures VFs to do MAC level filtering before the traffic is passed to VM.
When this field is set to true, VF will configured to strip the outer TAG before the traffic is passed to VM.
This option ensures anti VLAN spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
This option ensures anti MAC spoof checks are done at the VF level to comply with security. The disable check will also be honored per the VNF needs for trusted VMs.
This option defines the set of Mirror objects which essentially mirrors the traffic from source to set of collector VNF Ports.
This option, if set to true, sets the VF in promiscuous mode and allows all broadcast traffic to reach the VM
This option, if set to true, sets the VF in promiscuous mode and allows unknown multicast traffic to reach the VM
This option, if set to true, sets the VF in promiscuous mode and allows unknown unicast traffic to reach the VM
This option, if set to true, instructs to insert outer tag after traffic comes out of VM.
This option is used to set the link status. Valid values as of 1607 are on, off, and auto.
Neutron network id of the interface
A fabric subnet belongs to a zone.(4)
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor belongs To a subnet.(1)
A configuration uses a subnet
The route is part of part of a subnet.
A profile (set of characteristics) applies to the subnet.
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
text used for documentation
dhcp enabled
the start address reserved for use by dhcp
the last address reserved for use by dhcp
role of the subnet, referenced when assigning IPs
subnet model BGP, VRPP
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Subtype used to categorize this physical link
The function performed by this Linterface
ip address assignment direction of the subnet
sequence of the subnet
create/update/delete the sw-component node
The profile associated to a sw-component
The sw-component associated to a pnf
The sw-component associated to a pserver
The sw-component associated to a vserver
UUID
Name of software component
Type of software component
Role of software component
Function of software component
Instance of an te-link-attribute
For CCVPN Usecase(1)
For CCVPN Usecase(1)
Id that identifies the TE link attribute
Indicate desired protection type of the link e.g, unprotected, shared or 1+1
Indicate link access type e.g, point-to-point or multi-access.
Bandwidth available on link.
The type of ODU e.g, ODU1, ODU2, ODU3, ODU4.
The value of available bandwidth.
Indicate wheather link is abstract or native
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Openstack tenant
For CCVPN Usecase
Unique id relative to the cloud-region.
Readable name of tenant
This field will store the tenant context.
tenant parent-id
Instance of an tunnel termination point
For CCVPN Usecase(4)
For CCVPN Usecase(4)
For CCVPN Usecase(1)
Id that identifies the tunnel termination point
TTP ID discovered from controller
Name of tunnel termination point
Admin status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.
Operational status of TTP e.g, up,down,testing,preparing-maintenance,maintenance.
Indicate switching capability of TTP e.g,PSC-1, EVPL,L2SC,TDM,OTN.
Encoding support by the TTP e.g, packet,ethernet,PDH,SDH,digital-wrapper,lambda,fiber,ODUK,line.
Indicate supported protection type of this TTP e.g, unprotected,reroute,reroute-extra,1-for-n,unidir-1-to-1.
correlation between related objects in ETH and OTN topology.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Represents the specifics of a tunnel cross connect piece of a resource that gets separately allotted
Allotted Resource id UUID assigned to this instance.
Instance of an User network interface
For CCVPN Usecase
For CCVPN Usecase
Id that identifies the UNI
Termination point ID.
The cvlan for the site used for ethernet type connectivity.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Serves a PATCH like function. Does not enforce concurrency control. Clear each usage with AAI team.
validation audit, value of validation status
The validation-audit associated to a cloud-region(4)
The line-of-business associated to a validation-audit
Validation-Audit UUID
Request-id to retrieve data from client related to the specified audit
Status of the audit
Phase in the lifecycle of the configuration
Virtual Customer Edge Router, used specifically for Gamma. This object is deprecated.
Unique id of VNF. This is unique across the graph.
Name of VNF.
Alternate name of VNF.
String capturing type of vnf, that was intended to identify the SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures.
Unique identifier of service, does not strictly map to ASDC services, SOON TO BE DEPRECATED.
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
OBSOLETE - do not use
Network role being played by this VNF
Orchestration status of this VNF, mastered by MSO
Heat stack id corresponding to this instance, managed by MSO
Corresponds to the SDN-C catalog id used to configure this VCE
Unique ID of VPE connected to this VCE.
Valid v6 IP address for the WAN Link on this router. Implied length of /64.
Address tail-f uses to configure vce, also used for troubleshooting and is IP used for traps generated by VCE.
Loopback0 address
OBSOLETE - see child relationships
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 to indicate whether or not this object is base vf module
Indicates whether vf-module assignment was done via automation or manually
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
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
the index will track the number of modules of a given type that have been deployed in a VNF, starting with 0, and always choosing the lowest available digit
Path to the controller object.
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
vig-server contains information about a vig server used for IPSec-configuration. Populated by SDN-C from 1607
indicates whether the VIG is for AVPN or INTERNET
v4 IP of the vig server
v6 IP of the vig server
IPv4 Address Range
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a vip-ipv4-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the vip-ipv4-address-list of an R-Leaf's l-interface that is for VLAN 2
IP address
Prefix length, 32 for single address
Inner VLAN tag
Outer VLAN tag
Indicator of fixed or floating address
Neutron network id of the interface that address belongs to
Neutron id of subnet that address belongs to
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
IPv6 Address Range
To node-type is destination of bgp-group.
To node-type is source of bgp-group.
bgp-neighbor uses To node-type.
The fqdn that applies to a vip-ipv6-address-list.
This edge relates an object-group's ip-address-list through reference from DLP data to an ip-address from FCT in the vip-ipv6-address-list of an R-Leaf's l-interface that is for VLAN 2
IP address
Prefix length, 128 for single address
Inner VLAN tag
Outer VLAN tag
Indicator of fixed or floating address
Neutron network id of the interface that address belongs to
Neutron id of subnet that address belongs to
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Virtual organization of cloud infrastructure elements in a data center context
Unique ID of the vdc
Name of the virtual data center
Definition of vlan
String that identifies the interface
Inner VLAN tag
Outer VLAN tag
Captures the numeric part of the speed
Captures the units corresponding to the speed
The type of vlan (eg. vxlan)
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
Status of a vnf's vlan interface, on which the customer circuit resides, mastered by SDN-C.
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
Prov Status of the VLAN configuration related to a logical interface. Valid values [PREPROV/NVTPROV/PROV].
Flag indicating the interface uses the IP Unnumbered configuration.
Private VLAN indicator.
describes an vlan characteristic
UUID.
Name.
Device role the vlan-characteristic applies to (c-agg-leaf-a, c-agg-leaf-b, r-leaf).
DHCP Agent access.
Boolean to represent if requires internet access.
vlan-mapping object is an optional child object of the forwarder-evc object. A given forwarder-evc object may have multiple vlan-mapping objects.
Key for vlan-mapping object.
CVLAN value from the UNI/ingress side of the SAREA gateway access device.
SVLAN value from the NNI/egress side of the SAREA gateway access device.
CVLAN value from the NNI/egress side of the SAREA gateway access device.
The internal VLAN ('IVLAN') value. Specific to Arista devices.
Definition of vlan range
A vlan range belongs to a cloud-region.(4)
A line-of uses a vlan-range
An owning-entity uses a vlan-range.
A profile (set of characteristics) applies to the vlan-range.
A vlan-tag belongs to a vlan-range.(1)
vlan id in range UUID.
vlan id in range lower
vlan id in range upper
vlan type
vlan tag information
A vlan-tag belongs to a vlan-range.(4)
An sub-interface that uses a vlan-tag.
A l3-network Uses vlan-tag.
This edge allows for QOS policy to vlan-tag relationship. For a given policy get all vlan tags as well as for a given vlan-tag get all the policies.
A profile (set of characteristics) applies to the vlan-tag.
Vlan Tag Id
Role assigned to this vlan-tag
Inner VLAN tag
Outer VLAN tag
is private flag.
VLAN tag Type
VLAN Tag Function
The config-phase associated with this vlan-tag
Abstract vnf class
Unique id of VNF. This is unique across the graph.
Image object that pertain to a VNF that doesn't have associated vservers. This is a kludge.
Unique ID of this asset
The application that the image instantiates.
The vendor of the application.
The version of the application.
URL to endpoint where AAI can get more details
cp is child of vnfc(2)
Unique ID of vnfc.
Short code that is used in naming instances of the item being modeled
English description of function that the specific resource deployment is providing. Assigned as part of the customization of a resource in a service
prov status of this vnfc
Orchestration status of this VNF, mastered by APP-C
Oam V4 vip address of this vnfc
used to indicate whether or not this object is in maintenance mode (maintenance mode = true)
used to indicate whether closed loop function is enabled on this node
Group notation of VNFC
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
captures the id of all the configuration used to customize the resource for the service.
Ephemeral Block storage volume.
Unique ID of block storage volume relative to the vserver.
URL to endpoint where AAI can get more details
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 SDC resource. This field has been overloaded in service-specific ways and clients should expect changes to occur in the future to this field as ONAP matures.
Orchestration status of this volume-group
captures the id of all the configuration used to customize the resource for the service.
helps relate the volume group to the vf-module whose components will require the volume group
VPLS Provider Edge routers.
Trigger for operational monitoring of this VNF by BAU Service Assurance systems.
Address tail-f uses to configure generic-vnf, also used for troubleshooting and is IP used for traps generated by GenericVnf (v4-loopback0-ip-address).
Client should send valid enumerated value, e.g., VPLS-PE.
Temporary location for stag to get to VCE
VPN binding
A vpn-binding uses many aggregate routes
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
A policy uses vpn-bindings
A profile (set of characteristics) applies to the vpn-binding.
For CCVPN Usecase
A vrf uses a vpn-binding.
VPN ID, globally unique within A&AI
VPN Name
the platform associated with the VPN example AVPN, Mobility
Type of the vpn, should be taken from enumerated/valid values
region of customer vpn
id for this customer vpn
Used to distinguish the distinct VPN routes of separate customers who connect to the provider in an MPLS network.
Store the id of the access provider of this vpn.
Store the id of the access client of this vpn.
Store the id of the access topology of this vpn.
Store the id of the src-access-node of this vpn.
Store the id of the src-access-ltp of this vpn.
Store the id of the dst-access-node of this vpn.
Store the id of the dst-access-ltp of this vpn.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
Max prefix for IPv4.
Max prefix for IPv6.
Max prefix threshold.
Label mode for IPv4.
Label mode for IPv6.
The description of the vpn.
A VNI associated with the VPN.
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
A variable BGP max AS path length.
Definition of vrf
A vrf uses many l3-networks
Relates vrf to network-route for static routes.
The vrfs that are used by the next-hop.
A vrf belongs to a pnf.(4)
A vrf uses a vpn-binding.
An aggregate-route BelongsTo a vrf.(1)
A bgp-group belongs to a pnf.(1)
A bgp-neighbor belongs to a vrf.(1)
A Configuration uses VRFs
A profile (set of characteristics) applies to the vrf.
This edge relates a vrf that is configured on a pnf to the service-instances that the vrf supports.
VRF UUID.
VRF Name
VRF Description
Route Distinguisher
The type of vrf (bridge-domain as an example)
IP address family (v6/v4/both)
Notes to aid OPs in troubleshooting, such as attribute aliases or additional descriptions/instructions about an object.
Indicator for the use of this physical link
The function performed by this Linterface
Bridge domain group name
Virtual Servers, aka virtual machine or VM.
The sw-component associated to a vserver
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 to indicate whether or not this object is in maintenance mode (maintenance mode = true). This field (in conjunction with prov-status) is used to suppress alarms and vSCL on VNFs/VMs.
Used to indicate whether closed loop function is enabled on this node
Non-uniform memory access optimization, helps prevent memory-bandwidth bottlenecks. Expected values - 1 or 2 identifying memory access
Indicator for whether the resource is considered operational. Valid values are in-service-path and out-of-service-path.
Instance of a wan-port-config
For CCVPN Usecase
For CCVPN Usecase
For CCVPN Usecase
Uniquely identifies this wan-port-config by id
Store the name of this wan-port-config.
Store the id of the device of this wan-port-config.
Store the id of the vlan of this wan-port-config.
Store the ip-address of this wan-port-config.
Store the ipv4-address of this wan-port-config.
Store the ipv6-address of this wan-port-config.
Store the provider-ip-address of this wan-port-config.
Store the provider-ipv4-address of this wan-port-config.
Store the provider-ipv6-address of this wan-port-config.
Store the input-bandwidth of this wan-port-config.
Store the output-bandwidth of this wan-port-config.
Store the description of this wan-port-config.
Store the port-type of this wan-port-config.
Store the port-number of this wan-port-config.
Store the transport-network-name of this wan-port-config.
Store the device-port-id of this wan-port-config.
Store the wan-port-id of this wan-port-config.
Store the link to get more information for this object.
Store the operational-status for this object.
Store the model-customization-id for this object.
the ASDC model id for this resource or service model.
the ASDC model version for this resource or service model.
A zone is a grouping of assets in a location homing to the same connections into the CBB
A local autonomous-system is located in a zone.(1)
The contact supports a zone.
The network-range is located in a zone
A fabric subnet belongs to a zone.(1)
Code assigned by AIC to the zone
English name associated with the zone
The type of zone (ex. AIC or NC).
Design of zone [Medium/Large]
Context of zone [production/test]
Status of a zone.
Role of a zone.
Function of a zone.
Used to indicate whether or not zone object is in maintenance mode.